From 7cb3eaf2fe8ebba796c71d7967c8eafe830778f6 Mon Sep 17 00:00:00 2001 From: KieferVanTeutem Date: Wed, 5 Jun 2019 14:08:35 +0200 Subject: [PATCH] Html documentation update: Add description of generic sensor set and get functions, including the new matrix set and get functions, and the set and get functions for the number of detectors. Add a full list of sensor parameter tokens and possible states. Update error token list. --- docs/Ics_Error.html | 7 +- docs/Ics_Header.html | 69 +++++ docs/TopLevelFunctions.html | 565 +++++++++++++++++++++++------------- 3 files changed, 441 insertions(+), 200 deletions(-) diff --git a/docs/Ics_Error.html b/docs/Ics_Error.html index 4dd322e..88e7522 100644 --- a/docs/Ics_Error.html +++ b/docs/Ics_Error.html @@ -179,12 +179,15 @@

IcsErr_NotValidAction

ICS open for reading, or a 'Get' function is called on an ICS open for writing.

-

IcsErr_ToManyChans

+

IcsErr_TooManyChans

Too many channels specified.

-

IcsErr_ToManyDims

+

IcsErr_TooManyDims

Too many dimensions specified.

+

IcsErr_TooManyDetectors

+

Too many detectors specified.

+

IcsErr_UnknownCompression

Unknown compression type.

diff --git a/docs/Ics_Header.html b/docs/Ics_Header.html index 3b8f15e..2523f1c 100644 --- a/docs/Ics_Header.html +++ b/docs/Ics_Header.html @@ -527,6 +527,75 @@

Type

type: char [ICS_STRLEN_TOKEN]

+

Microscopy parameter tokens

+ +

Every microscopy parameter has a token that can be used in the generic + Set and Get functions + to change the value(s). The possible tokens are: + +

+ ICS_SENSOR_IMAGING_DIRECTION
+ ICS_SENSOR_NUMERICAL_APERTURE
+ ICS_SENSOR_OBJECTIVE_QUALITY
+ ICS_SENSOR_MEDIUM_REFRACTIVE_INDEX
+ ICS_SENSOR_LENS_REFRACTIVE_INDEX
+ ICS_SENSOR_PINHOLE_RADIUS
+ ICS_SENSOR_ILL_PINHOLE_RADIUS
+ ICS_SENSOR_PINHOLE_SPACING
+ ICS_SENSOR_EXCITATION_BEAM_FILL
+ ICS_SENSOR_LAMBDA_EXCITATION
+ ICS_SENSOR_LAMBDA_EMISSION
+ ICS_SENSOR_PHOTON_COUNT
+ ICS_SENSOR_INTERFACE_PRIMARY
+ ICS_SENSOR_INTERFACE_SECONDARY
+ ICS_SENSOR_DESCRIPTION
+
+ ICS_SENSOR_DETECTOR_MAGN
+ ICS_SENSOR_DETECTOR_PPU
+ ICS_SENSOR_DETECTOR_BASELINE
+ ICS_SENSOR_DETECTOR_LINE_AVG_COUNT
+
+ ICS_SENSOR_DETECTOR_OFFSET
+ ICS_SENSOR_DETECTOR_SENSITIVITY
+ ICS_SENSOR_DETECTOR_RADIUS
+ ICS_SENSOR_DETECTOR_SCALE
+ ICS_SENSOR_DETECTOR_STRETCH
+ ICS_SENSOR_DETECTOR_ROT
+ ICS_SENSOR_DETECTOR_MIRROR
+ ICS_SENSOR_DETECTOR_MODEL
+ ICS_SENSOR_DETECTOR_REDUCEHIST
+
+ ICS_SENSOR_STED_DEPLETION_MODE
+ ICS_SENSOR_STED_LAMBDA
+ ICS_SENSOR_STED_SATURATION_FACTOR
+ ICS_SENSOR_STED_IMM_FRACTION
+ ICS_SENSOR_STED_VPPM
+
+ ICS_SENSOR_SPIM_EXCITATION_TYPE
+ ICS_SENSOR_SPIM_FILL_FACTOR
+ ICS_SENSOR_SPIM_PLANE_NA
+ ICS_SENSOR_SPIM_PLANE_GAUSS_WIDTH
+ ICS_SENSOR_SPIM_PLANE_PROP_DIR
+ ICS_SENSOR_SPIM_PLANE_CENTER_OFF
+ ICS_SENSOR_SPIM_PLANE_FOCUS_OFF
+
+ ICS_SENSOR_SCATTER_MODEL
+ ICS_SENSOR_SCATTER_FREE_PATH
+ ICS_SENSOR_SCATTER_REL_CONTRIB
+ ICS_SENSOR_SCATTER_BLURRING
+
+

+ +

Microscopy parameter states

+ +

Every microscopy parameter has a state indicating where the parameter came from / + the level of confidence we have in the parameter. Possible values:

+ IcsSensorState_default
+ IcsSensorState_estimated
+ IcsSensorState_reported
+ IcsSensorState_verified
+

+ diff --git a/docs/TopLevelFunctions.html b/docs/TopLevelFunctions.html index 544222f..d7d4197 100644 --- a/docs/TopLevelFunctions.html +++ b/docs/TopLevelFunctions.html @@ -78,7 +78,7 @@

IcsClose

Ics_Error IcsClose - (ICSics); + (ICS *ics);

Close the ICS file. The ics 'stream' is no longer @@ -109,7 +109,7 @@

IcsClose

IcsGetErrorText

- char constIcsGetErrorText + const char *IcsGetErrorText (Ics_Error error);

@@ -119,7 +119,7 @@

IcsGetErrorText

IcsGetLibVersion

- char constIcsGetLibVersion + const char *IcsGetLibVersion (void);

@@ -131,11 +131,11 @@

IcsLoadPreview

Ics_Error IcsLoadPreview - (char constfilename, + (const char *filename, size_t planenumber, - void** dest, - size_txsize, - size_tysize); + void *dest, + size_t *xsize, + size_t *ysize);

Read a 2D preview image out of an ICS file. @@ -188,9 +188,9 @@

IcsOpen

Ics_Error IcsOpen - (ICS** ics, - char constfilename, - char constmode); + (ICS **ics, + const char *filename, + const char *mode);

Open an ICS file for reading @@ -251,7 +251,7 @@

IcsVersion

int IcsVersion - (char constfilename, + (const char *filename, int forcename);

@@ -267,8 +267,8 @@

IcsGetData

Ics_Error IcsGetData - (ICSics, - voiddest, + (ICS *ics, + void *dest, size_t n);

@@ -295,8 +295,8 @@

IcsGetDataBlock

Ics_Error IcsGetDataBlock - (ICSics, - voiddest, + (ICS *ics, + void *dest, size_t n);

@@ -326,7 +326,7 @@

IcsGetDataSize

size_t IcsGetDataSize - (ICS constics); + (const ICS *ics);

Returns the size of the data block in bytes.

@@ -335,10 +335,10 @@

IcsGetDataWithStrides

Ics_Error IcsGetDataWithStrides - (ICSics, - void constsrc, + (ICS *ics, + const void *src, size_t n, - ptrdiff_t conststrides, + const ptrdiff_t *strides, int ndims);

@@ -372,7 +372,7 @@

IcsGetImageSize

size_t IcsGetImageSize - (ICS constics); + (const ICS *ics);

Returns the size of the image in imels.

@@ -381,7 +381,7 @@

IcsGetImelSize

size_t IcsGetImelSize - (ICS constics); + (const ICS *ics);

Returns the size of imels in bytes.

@@ -390,10 +390,10 @@

IcsGetLayout

Ics_Error IcsGetLayout - (ICS constics, - Ics_DataTypedt, - intndims, - size_tdims); + (const ICS *ics, + Ics_DataType *dt, + int *ndims, + size_t *dims);

Retrieve the layout of an ICS image.

@@ -405,8 +405,8 @@

IcsGetPreviewData

Ics_Error IcsGetPreviewData - (ICSics, - voiddest, + (ICS *ics, + void *dest, size_t n, size_t planenumber);

@@ -449,11 +449,11 @@

IcsGetROIData

Ics_Error IcsGetROIData - (ICSics, - size_t constoffset, - size_t constsize, - size_t constsampling, - voiddest, + (const ICS *ics, + const size_t *offset, + const size_t *size, + const size_t *sampling, + void *dest, size_t n);

@@ -490,8 +490,8 @@

IcsGetSignificantBits

Ics_Error IcsGetSignificantBits - (ICS constics, - size_tnbits); + (const ICS *ics, + size_t *nbits);

Get the number of significant bits.

@@ -503,7 +503,7 @@

IcsSkipDataBlock

Ics_Error IcsSkipDataBlock - (ICSics, + (ICS *ics, size_t n);

@@ -538,7 +538,7 @@

IcsSetCompression

Ics_Error IcsSetCompression - (ICSics, + (ICS *ics, Ics_Compression  compression, int level);

@@ -558,8 +558,8 @@

IcsSetData

Ics_Error IcsSetData - (ICSics, - void constsrc, + (ICS *ics, + const void *src, size_t n);

@@ -581,10 +581,10 @@

IcsSetDataWithStrides

Ics_Error IcsSetDataWithStrides - (ICSics, - void constsrc, + (ICS *ics, + const void *src, size_t n, - ptrdiff_t conststrides, + const ptrdiff_t *strides, int ndims);

@@ -610,10 +610,10 @@

IcsSetLayout

Ics_Error IcsSetLayout - (ICSics, + (ICS *ics, Ics_DataType dt, int ndims, - size_t constdims); + const size_t *dims);

Set the layout for an ICS image.

@@ -626,7 +626,7 @@

IcsSetSignificantBits

Ics_Error IcsSetSignificantBits - (ICSics, + (ICS *ics, size_t nbits);

@@ -640,8 +640,8 @@

IcsSetSource

Ics_Error IcsSetSource - (ICSics, - char constfname, + (ICS *ics, + const char *fname, size_t offset);

@@ -656,8 +656,8 @@

IcsSetByteOrder

Ics_Error IcsSetByteOrder - (ICSics, - Ics_ByteOrderorder); + (ICS *ics, + Ics_ByteOrder *order);

Set the image source byte order for an ICS version 2.0 file. Only valid if @@ -676,8 +676,8 @@

IcsGetCoordinateSystem Ics_Error IcsGetCoordinateSystem - (ICS constics, - charcoord); + (const ICS *ics, + char *coord);

Get the coordinate system used in the positioning of @@ -692,10 +692,10 @@

IcsGetImelUnits

Ics_Error IcsGetImelUnits - (ICS constics, - doubleorigin, - doublescale, - charunits); + (const ICS *ics, + double *origin, + double *scale, + char *units);

Set the position of the pixel values: the offset and @@ -709,10 +709,10 @@

IcsGetImelUnitsF

Ics_Error IcsGetImelUnitsF - (ICS constics, - doubleorigin, - doublescale, - const char** units); + (ICS const *ics, + double *origin, + double *scale, + const char *units);

Same as IcsGetImelUnits, @@ -727,10 +727,10 @@

IcsGetOrder

Ics_Error IcsGetOrder - (ICS constics, + (const ICS *ics, int dimension, - charorder, - charlabel); + char *order, + char *label);

Get the ordering of the dimensions in the image. The @@ -744,10 +744,10 @@

IcsGetOrderF

Ics_Error IcsGetOrderF - (ICS constics, + (const ICS *ics, int dimension, - const char** order, - const char** label); + const char **order, + const char **label);

Same as IcsGetOrder, @@ -762,11 +762,11 @@

IcsGetPosition

Ics_Error IcsGetPosition - (ICS constics, + (const ICS *ics, int dimension, - doubleorigin, - doublescale, - charunits); + double *origin, + double *scale, + char *units);

Get the position of the image in the real world: the @@ -781,11 +781,11 @@

IcsGetPositionF

Ics_Error IcsGetPositionF - (ICS constics, + (const ICS *ics, int dimension, - doubleorigin, - doublescale, - const char** units); + double *origin, + double *scale, + const char **units);

Same as IcsGetPosition, @@ -800,8 +800,8 @@

IcsGetScilType

Ics_Error IcsGetScilType - (ICS constics, - charsciltype); + (const ICS *ics, + char *sciltype);

Get the string for the SCIL_TYPE parameter. This string is @@ -814,7 +814,7 @@

IcsGuessScilType

Ics_Error IcsGuessScilType - (ICSics); + (ICS *ics);

As @@ -837,8 +837,8 @@

IcsSetCoordinateSystem Ics_Error IcsSetCoordinateSystem - (ICSics, - char constcoord); + (ICS *ics, + const char *coord);

Set the coordinate system used in the positioning of @@ -853,10 +853,10 @@

IcsSetImelUnits

Ics_Error IcsSetImelUnits - (ICSics, + (ICS *ics, double origin, double scale, - char constunits); + const char *units);

Set the position of the pixel values: the offset and @@ -871,11 +871,11 @@

IcsSetPosition

Ics_Error IcsSetPosition - (ICSics, + (ICS *ics, int dimension, double origin, double scale, - char constunits); + const char *units);

Set the position of the image in the real world: the @@ -891,10 +891,10 @@

IcsSetOrder

Ics_Error IcsSetOrder - (ICSics, + (ICS *ics, int dimension, - char constorder, - char constlabel); + const char *order, + const char *label);

Set the ordering of the dimensions in the image. The @@ -908,8 +908,8 @@

IcsSetScilType

Ics_Error IcsSetScilType - (ICSics, - char constsciltype); + (ICS *ics, + const char *sciltype);

Set the string for the SCIL_TYPE parameter. This string @@ -942,9 +942,9 @@

IcsAddHistoryString

Ics_Error IcsAddHistoryString - (ICSics, - char constkey, - char constvalue); + (ICS *ics, + const char *key, + const char *value);

Add history lines to the ICS file. key can be @@ -965,8 +965,8 @@

IcsDeleteHistory

Ics_Error IcsDeleteHistory - (ICSics, - charkey); + (ICS *ics, + char *key);

Delete all history lines with key key. If @@ -980,8 +980,8 @@

IcsDeleteHistoryStringI<

Ics_Error IcsDeleteHistoryStringI - (ICSics, - Ics_HistoryIteratorit); + (ICS *ics, + Ics_HistoryIterator *it);

Delete the last history lines retrieved through it.

@@ -993,9 +993,9 @@

IcsGetHistoryKeyValue

Ics_Error IcsGetHistoryKeyValue - (ICSics, - charkey, - charvalue, + (ICS *ics, + char *key, + char *value, Ics_HistoryWhich which);

@@ -1022,10 +1022,10 @@

IcsGetHistoryKeyValueI Ics_Error IcsGetHistoryKeyValueI - (ICSics, - Ics_HistoryIteratorit, - charkey, - charvalue); + (ICS *ics, + Ics_HistoryIterator *it, + char *key, + char *value);

Get the history lines from the ICS file. key @@ -1045,10 +1045,10 @@

IcsGetHistoryKeyValueIF<

Ics_Error IcsGetHistoryKeyValueIF - (ICSics, - Ics_HistoryIteratorit, - charkey, - const char** value); + (ICS *ics, + Ics_HistoryIterator *it, + char *key, + const char **value);

Same as IcsGetHistoryKeyValueI, @@ -1066,8 +1066,8 @@

IcsGetHistoryString

Ics_Error IcsGetHistoryString - (ICSics, - charstring, + (ICS *ics, + char *string, Ics_HistoryWhich which);

@@ -1091,9 +1091,9 @@

IcsGetHistoryStringI

Ics_Error IcsGetHistoryStringI - (ICSics, - Ics_HistoryIteratorit, - charstring); + (ICS *ics, + Ics_HistoryIterator *it, + char *string);

Get the history lines from the ICS file. string @@ -1110,9 +1110,9 @@

IcsGetHistoryStringIF

Ics_Error IcsGetHistoryStringIF - (ICSics, - Ics_HistoryIteratorit, - const char** string); + (ICS *ics, + Ics_HistoryIterator *it, + const char **string);

Same as IcsGetHistoryKeyValueI, @@ -1130,8 +1130,8 @@

IcsGetNumHistoryStrings<

Ics_Error IcsGetNumHistoryStrings - (ICSics, - intnum); + (ICS *ics, + int *num);

Get the number of history lines from the ICS file. num @@ -1145,9 +1145,9 @@

IcsNewHistoryIterator

Ics_Error IcsNewHistoryIterator - (ICSics, - Ics_HistoryIteratorit, - charkey); + (ICS *ics, + Ics_HistoryIterator *it, + char *key);

Initializes a history iterator. key @@ -1161,10 +1161,10 @@

IcsReplaceHistoryString

Ics_Error IcsReplaceHistoryStringI - (ICSics, - Ics_HistoryIteratorit, - char constkey, - char constvalue); + (ICS *ics, + Ics_HistoryIterator *it, + const char *key, + const char *value);

Replace the last history lines retrieved through it. @@ -1181,10 +1181,14 @@

IcsReplaceHistoryString

Sensor metadata functions

-

The functions below give access to the sensor parameters. - For each parameter both a Get and a Set function are provided. - The Set functions all perform error checking and insist that the ICS - structure is in writing or updating mode. Please note that +

The functions below give access to the sensor parameters. For most + parameters dedicated Set and Get functions are provided. However, some + parameters can only be accessed using generic Set and Get functions, + along with a + token + specifying the parameter. The Set functions all perform + error checking and insist that the ICS structure is in writing or updating mode. + Please note that IcsEnableWriteSensor must be called to enable writing the sensor parameters to file. To use these functions you need to add @@ -1210,23 +1214,118 @@

IcsGetSensorChannels

int IcsGetSensorChannels - (ICS - const* - ics); + (const ICS *ics);

Return the number of sensor channels.

+

IcsGetSensorDetectors

+ +

+ int + IcsGetSensorDetectors + (const ICS *ics); +

+ +

Return the number of sensor detectors.

+ +

IcsGetSensorParameter

+ +

+ Ics_Error + IcsGetSensorParameter + (const ICS *ics, + Ics_SensorParameter parameter, + int channel, + double *value, + Ics_SensorState + *state); +

+ +

Generic get function for parameters represented by doubles.

+ +

errors: + IcsErr_NotValidAction.

+ +

IcsGetSensorParameterVector

+ +

+ Ics_Error + IcsGetSensorParameterVector + (const ICS *ics, + Ics_SensorParameter parameter, + int channel, + const double **values, + Ics_SensorState + *state); +

+ +

Generic get function for parameters represented by a vector of doubles. The double **values + represents a pointer to an array of doubles, which is set by the function.

+ +

errors: + IcsErr_NotValidAction.

+ +

IcsGetSensorParameterMatrix

+ +

+ Ics_Error + IcsGetSensorParameterMatrix + (const ICS *ics, + Ics_SensorParameter parameter, + int channel, + const double **values, + Ics_SensorState + *state); +

+ +

Generic get function for parameters represented by a matrix of doubles. The double **values + represents a pointer to a flattened array of doubles, which is set by the function.

+ +

errors: + IcsErr_NotValidAction.

+ +

IcsGetSensorParameterInt

+ +

+ Ics_Error IcsGetSensorParameterInt + (const ICS *ics, + Ics_SensorParameter parameter, + int channel, + int *value, + Ics_SensorState + *state); +

+ +

Generic get function for parameters represented by ints.

+ +

errors: + IcsErr_NotValidAction.

+ +

IcsGetSensorParameterString

+ +

+ Ics_Error IcsGetSensorParameterString + (const ICS *ics, + Ics_SensorParameter parameter, + int channel, + const char **value, + Ics_SensorState *state); +

+ +

Generic get function for parameters represented by a string. The char **value + represents a pointer to a char array, which is set by the function.

+ +

errors: + IcsErr_NotValidAction.

+

IcsGetSensorEmissionWavelength

double IcsGetSensorEmissionWavelength - (ICS - const* - ics, - int - channel); + (const ICS *ics, + int channel);

Return the emission wavelength for a given channel.

@@ -1236,11 +1335,8 @@

IcsGetSensorExc

double IcsGetSensorExcitationWavelength - (ICS - const* - ics, - int - channel); + (const ICS *ics, + int channel);

Return the excitation wavelength for a given channel.

@@ -1250,9 +1346,7 @@

IcsGetSensorLensRI

double IcsGetSensorLensRI - (ICS - const* - ics); + (const ICS *ics);

Return the design medium refractive index.

@@ -1262,9 +1356,7 @@

IcsGetSensorMediumRI

double IcsGetSensorMediumRI - (ICS - const* - ics); + (const ICS *ics);

Return the embedding medium refractive index.

@@ -1272,11 +1364,9 @@

IcsGetSensorMediumRI

IcsGetSensorModel

- char const* + const char* IcsGetSensorModel - (ICS - const* - ics); + (const ICS *ics);

Return a pointer to the sensor model string.

@@ -1286,9 +1376,7 @@

IcsGetSensorNumAperture<

double IcsGetSensorNumAperture - (ICS - const* - ics); + (const ICS *ics);

Return the sensor numerical apperture.

@@ -1298,9 +1386,7 @@

IcsGetSensorPhotonCount<

int IcsGetSensorPhotonCount - (ICS - const* - ics, + (const ICS *ics, int channel);

@@ -1312,9 +1398,7 @@

IcsGetSensorPinholeRad

double IcsGetSensorPinholeRadius - (ICS - const* - ics, + (const ICS *ics, int channel);

@@ -1326,9 +1410,7 @@

IcsGetSensorPinholeSp

double IcsGetSensorPinholeSpacing - (ICS - const* - ics); + (const ICS *ics);

Return the Nipkow Disk pinhole spacing.

@@ -1336,11 +1418,9 @@

IcsGetSensorPinholeSp

IcsGetSensorSTEDDepletionMode

- char const* + const char* IcsGetSensorSTEDDepletionMode - (ICS - const* - ics, + (const ICS *ics, int channel);

@@ -1352,9 +1432,7 @@

IcsGetSensorSTEDImmF

double IcsGetSensorSTEDImmFraction - (ICS - const* - ics, + (const ICS *ics, int channel);

@@ -1366,9 +1444,7 @@

IcsGetSensorSTEDLambda double IcsGetSensorSTEDLambda - (ICS - const* - ics, + (const ICS *ics, int channel);

@@ -1378,11 +1454,9 @@

IcsGetSensorSTEDLambdaIcsGetSensorSTEDPPMode

- char const* + const char* IcsGetSensorSTEDPPMode - (ICS - const* - ics, + (const ICS *ics, int channel);

@@ -1394,9 +1468,7 @@

IcsGetSensorSTEDSatFac

double IcsGetSensorSTEDSatFactor - (ICS - const* - ics, + (const ICS *ics, int channel);

@@ -1408,9 +1480,7 @@

IcsGetSensorSTEDVPPM

double IcsGetSensorSTEDVPPM - (ICS - const* - ics, + (const ICS *ics, int channel);

@@ -1422,9 +1492,7 @@

IcsGetSensorDetectorPPU<

double IcsGetSensorDetectorPPU - (ICS - const* - ics, + (const ICS *ics, int channel);

@@ -1436,9 +1504,7 @@

IcsGetSensorDetecto

double IcsGetSensorDetectorBaseline - (ICS - const* - ics, + (const ICS *ics, int channel);

@@ -1450,9 +1516,7 @@

IcsGetSensorDetec

double IcsGetSensorDetectorLineAvgCnt - (ICS - const* - ics, + (<const ICS *ics, int channel);

@@ -1462,11 +1526,9 @@

IcsGetSensorDetec

IcsGetSensorType

- char const* + const char* IcsGetSensorType - (ICS - const* - ics, + (const ICS *ics, int channel);

@@ -1487,6 +1549,113 @@

IcsSetSensorChannels

Set the number of sensor channels. This number may not exceed ICS_MAX_LAMBDA.

+

IcsSetSensorDetectors

+ +

+ Ics_Error + IcsSetSensorDetectors + (ICS* + ics, + int + detectors); +

+ +

Set the number of sensor detectors. This number may not exceed + ICS_MAX_DETECT.

+ +

IcsSetSensorParameter

+ +

+ Ics_Error IcsSetSensorParameter + (ICS *ics, + Ics_SensorParameter parameter, + int channel, + double value, + Ics_SensorState state); +

+ +

Generic set function for parameters represented by doubles. Note that you + must also set the state of the parameter.

+ +

errors: + IcsErr_NotValidAction.

+ +

IcsSetSensorParameterVector

+ +

+ Ics_Error IcsSetSensorParameterVector + (ICS *ics, + Ics_SensorParameter + parameter, + int channel, + int nValues, + double *values, + Ics_SensorState state); +

+ +

Generic set function for parameters represented by a vector of doubles. + Double *values represents an array of doubles and nValues specifies the size + of the vector. Note that you must also set the state of the parameter.

+ +

errors: + IcsErr_NotValidAction.

+ +

IcsSetSensorParameterMatrix

+ +

+ Ics_Error IcsSetSensorParameterMatrix + (ICS *ics, + Ics_SensorParameter parameter, + int channel, + int nValues, + int mValues, + double *values, + Ics_SensorState state); +

+ +

Generic set function for parameters represented by a matrix of doubles. + Double *values represents a flattened array of doubles and (nValues, mValues) + specifies the size of the matrix. Note that you must also set the state of the parameter.

+ +

errors: + IcsErr_NotValidAction.

+ +

IcsSetSensorParameterInt

+ +

+ Ics_Error IcsSetSensorParameterInt + (ICS *ics, + Ics_SensorParameter parameter, + int channel, + int value, + Ics_SensorState state); +

+ +

Generic set function for parameters represented by ints. Note that you + must also set the state of the parameter.

+ +

errors: + IcsErr_NotValidAction.

+ +

IcsSetSensorParameterString

+ +

+ Ics_Error IcsSetSensorParameterString + (ICS *ics, + Ics_SensorParameter + parameter, + int channel, + const char + *value, + Ics_SensorState state); +

+ +

Generic set function for parameters represented by a string. Note that you + must also set the state of the parameter.

+ +

errors: + IcsErr_NotValidAction.

+

IcsSetSensorEmissionWavelength

@@ -1552,7 +1721,7 @@

IcsSetSensorModel

IcsSetSensorModel (ICS* ics, - char const* + const char* sensor_model);

@@ -1625,7 +1794,7 @@

IcsSetSensorSTEDDe ics, int channel, - char const* + const char* depletion_mode);

@@ -1670,7 +1839,7 @@

IcsSetSensorSTEDPPModeics, int channel, - char const* + const char* pp_mode);

@@ -1760,7 +1929,7 @@

IcsSetSensorType

ics, int channel, - char const* + const char* sensor_type);

@@ -1788,7 +1957,7 @@

IcsPrintIcs

void IcsPrintIcs - (ICS constics); + (ICS const *ics);

Prints the contents of the