10.11.2012 Views

Reference Manual of the nadc-tools API and Libraries - SRON

Reference Manual of the nadc-tools API and Libraries - SRON

Reference Manual of the nadc-tools API and Libraries - SRON

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

6.3 SDMF get clusConf<br />

Identifier SDMF get clusConf<br />

Author R.M. van Hees<br />

Language ANSI C<br />

Purpose obtain cluster configuration parameters<br />

Comment contains SDMF get clusParam, SDMF get statePET,<br />

SDMF get stateCoadd, SDMF get stateCount<br />

SDMF PET2StateID<br />

6.3.1 SDMF get stateParam<br />

Identifier SDMF get stateParam<br />

Purpose obtain number <strong>of</strong> readouts for given orbit<br />

Usage SDMF get stateParam( stateID, orbit, channel, &ipet, orbit range );<br />

Input unsigned char stateID : state ID [1..70]<br />

unsigned short orbit : orbit number<br />

unsigned short channel : channel ID [1..8]<br />

Output unsigned short *int pet : pixel exposure time * 32<br />

int *orbit range : orbit range with same state definition as orbit<br />

Returns nothing<br />

Comment none<br />

6.3.2 SDMF get statePET<br />

Identifier SDMF get statePET<br />

Purpose obtain PET for given state, orbit <strong>and</strong> channel<br />

Usage SDMF get statePET( stateID, orbit, channel, pet );<br />

Input unsigned char stateID : state ID<br />

unsigned short orbit : orbit number<br />

unsigned short channel : channel ID or zero for all channels<br />

Output float : pixel exposure time (s)<br />

Returns nothing, error status passed by global variable “<strong>nadc</strong> stat”<br />

Comment none<br />

6.3.3 SDMF get stateCoadd<br />

Identifier SDMF get stateCoadd<br />

Purpose obtain co-add factor for given state, orbit <strong>and</strong> cluster<br />

Usage coaddf = SDMF get stateCoadd( stateID, orbit, clusID );<br />

Input unsigned char stateID : state ID<br />

unsigned short orbit : orbit number<br />

unsigned short clusID : cluster ID<br />

Returns co-adding factor (unsigned char),<br />

error status passed by global variable “<strong>nadc</strong> stat”<br />

Comment none<br />

169

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!