ISOCAM Interactive Analysis User's Manual Version 5.0 - ISO - ESA

16.1. CIA DATA STRUCTURE INTERFACE ROUTINES 189
16.1.1.4 sad init
This function initialises an SAD in memory. An example, following from the Section 16.1.1.3 is:
CIA> sad1 = sad_init( ’143006010101’, ssid=ssad1, ack=ok )
CIA> help, sad1, ok
SAD1 STRING = ’CSAD143006010101_96080513124826’
OK INT = 1
The first argument is the combined number that is used to
name the returned SSAD, ssad1, that is created by ssad init (see Section 15.2.1). The keyword
ssid specifies the name of the SSAD we have initialised in Section 16.1.1.3, and to which sad1
now belongs. A keyword argument not used here is source, whichcanbeusedtopassanalready
existing SAD to sad init so as to copy its parameters to sad1.
16.1.1.5 cds init
This function initialises a CDS in memory. An example of its usage follows.
CIA> cds1 = cds_init( ’ccgswdark’, ack=ack )
CIA> help, cds1, ack
STRING = ’CCDS123456789012_95012318401579’
ACK INT = 1
The first argument is the type of the returned CDS, cds1. The possible types of CDSs are
given in Table 15.3.2.
16.1.2 structure extract
This function simply extracts data from a CIA structure and places it in a regular IDL structure.
A simple example for an SCD is:
CIA> regular_struct = scd_extract( ’CSCD143006010110_97092611592803’ )
Now we can use IDL’s HELP to look at the guts of regular struct.
CIA> help, regular_struct, /str
etc...
16.1.3 structure put
Procedure to place a value in a field of a structure. This can be a useful routine when a data
structure field is undefined or incorrectly defined. The fields for the relevant structure are given
in Chapter 15. Note that you should be careful when using structure put. Changing a field
value unnecessarily may disrupt your data. On no account change the field .NAME – it will
confuse CIA memory management. Also read Section 16.4 before attempting to manipulate the
MASK with scd put.
As an example, the string ’EARTH’ is placed in the field .NAME of the specified SCD.
CIA> scd_put, ’target’, ’EARTH’, ’CSCD143006010105_96080110071423’, ack=ack