NASA Logo
Ocean Color Science Software

ocssw V2022
sensorInfo.h File Reference
#include <sensorDefs.h>
#include <stdint.h>
Include dependency graph for sensorInfo.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

int32_t rdsensorinfo (int32_t sensorID, int32_t evalmask, const char *pname, void **pval)
 
const char * sensorId2SensorName (int sensorId)
 
const char * sensorId2InstrumentName (int sensorId)
 
const char * sensorId2PlatformName (int sensorId)
 
const char * sensorId2SensorDir (int sensorId)
 
const char * subsensorId2SubsensorDir (int subsensorId)
 
int sensorId2InstrumentId (int sensorId)
 
const char * instrumentId2InstrumentName (int instrumentId)
 
int sensorName2SensorId (const char *sensorName)
 
int instrumentPlatform2SensorId (const char *instrument, const char *platform)
 
int sensorId2SubsensorId (int sensorId)
 
const char * instrumentPlatform2SensorName (const char *instrument, const char *platform)
 

Function Documentation

◆ instrumentId2InstrumentName()

const char* instrumentId2InstrumentName ( int  instrumentId)

get the name of the instrument for this instrument ID

Parameters
instrumentIdinstrument identifier to look up
Returns
const char* instrument name or NULL if not found

Definition at line 357 of file sensorInfo.c.

◆ instrumentPlatform2SensorId()

int instrumentPlatform2SensorId ( const char *  instrument,
const char *  platform 
)

lookup the sensorID for a given instrument and platform

Parameters
instrumentinstrument to use for sensorID look up
platformplatform to use for sensorID lookup
Returns
the matching sensorID, or -1 if not found

Definition at line 405 of file sensorInfo.c.

◆ instrumentPlatform2SensorName()

const char* instrumentPlatform2SensorName ( const char *  instrument,
const char *  platform 
)

fine the sensor name given the instrument and platform

Parameters
instrumentname of instrument
platformname of platform
Returns
sensor name

Definition at line 473 of file sensorInfo.c.

◆ rdsensorinfo()

int32_t rdsensorinfo ( int32_t  sensorID,
int32_t  evalmask,
const char *  pname,
void **  pval 
)

lookup information about a sensor.

Parameters
sensorIDid of the sensor to lookup
evalmaskset to 32 to get info out of the "eval" directory
pnamename of the parameter to retrieve
pvalpointer to the requested data
Returns
the number of bands, -1 if error

Definition at line 69 of file rdsensorinfo.c.

◆ sensorId2InstrumentId()

int sensorId2InstrumentId ( int  sensorId)

Get the instrument ID for this sensor ID

Parameters
sensorIdsensor identifier to look up.
Returns
int instrument ID for this sensor. -1 if invalid sensorId.

Definition at line 343 of file sensorInfo.c.

◆ sensorId2InstrumentName()

const char* sensorId2InstrumentName ( int  sensorId)

Get the name of the instrument for this sensorId.

Parameters
sensorIdsensor identifier to look up.
Returns
name of the instrument or NULL if not found.

Definition at line 287 of file sensorInfo.c.

◆ sensorId2PlatformName()

const char* sensorId2PlatformName ( int  sensorId)

Get the name of the platform for this sensorId.

Parameters
sensorIdsensor identifier to look up.
Returns
name of the platform or NULL if not found.

Definition at line 301 of file sensorInfo.c.

◆ sensorId2SensorDir()

const char* sensorId2SensorDir ( int  sensorId)

Get the name of the sensor directory for this sensorId.

Parameters
sensorIdsensor identifier to look up.
Returns
sensor directory or NULL if not found.

Definition at line 315 of file sensorInfo.c.

◆ sensorId2SensorName()

const char* sensorId2SensorName ( int  sensorId)

Get the name of the sensor for this sensorId.

Parameters
sensorIdsensor identifier to look up.
Returns
name of sensor or NULL if not found.

Definition at line 273 of file sensorInfo.c.

◆ sensorId2SubsensorId()

int sensorId2SubsensorId ( int  sensorId)

return the subsensorId for the given sensorId

Parameters
sensorIdsensorId to lookup
Returns
the subsensorId, or -1 if not found

Definition at line 438 of file sensorInfo.c.

◆ sensorName2SensorId()

int sensorName2SensorId ( const char *  name)

lookup the ID for a sensor name

Parameters
sensorNamename of the sensor to lookup
Returns
sensor ID for the given sensor, -1 if not found.

Definition at line 371 of file sensorInfo.c.

◆ subsensorId2SubsensorDir()

const char* subsensorId2SubsensorDir ( int  subsensorId)

Get the name of the subsensor directory for this subsensorId.

Parameters
subsensorIdsubsensor identifier to look up.
Returns
subsensor directory or NULL if not found.

Definition at line 329 of file sensorInfo.c.