ewdb_internal_GetChanCTFForChannel()

Prototype: |
int ewdb_internal_GetChanCTFForChannel( | EWDB_ChanTCTFStruct * pChanCTF);
Source File: | src/oracle/schema-working/src/infra/ewdb_internal_GetChanCTFForChannel.c
Description: | Function retrieves the gain, sample rate, and ID of the poles and zeroes based transform function, for a given channel time interval identified by pChanCTF->idChanT.
Note: | ewdb_api_GetTransformFunctionForChan() should generally be called instead of this function. It provides the whole suite of transfer function information, including the transfer function.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success.
PARAMETER INFO
Parameter | Type | Description
pChanCTF | EWDB_ChanTCTFStruct * | Pointer to a caller allocated EWDB_ChanTCTFStruct. The function will read the idChanT(channel time interval identifier) from the struct, and then write the gain(dGain), sample rate(dSampRate), and cooked transform function identifier(idCookedTF) associated with the given idChanT back to the structure.
Group: | EWDB_API_LIB
Sub Group: | COOKED_INFRASTRUCTURE-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h

ewdb_internal_GetTransformFunction()

Prototype: |
int ewdb_internal_GetTransformFunction( | EWDBid idCookedTF, EWDB_TransformFunctionStruct * pCookedTF);
Source File: | src/oracle/schema-working/src/infra/ewdb_internal_GetTransformFunction.c
Description: | Function retrieves the poles/zeroes based transform function identified by idCookedTF from the DB. The transform Function is used to transform recorded waveforms back into ground motion.
Note: | Call ewdb_api_GetTransformFunctionForChan() to retrieve the transform function for a given channel along with gain and sample rate.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success.
PARAMETER INFO
Parameter | Type | Description
idCookedTF | EWDBid | The DB ID of the cooked transform function that the caller wants to retrieve.
pCookedTF | EWDB_TransformFunctionStruct * | Pointer to a caller allocated EWDB_TransformFunctionStruct where the function will write the cooked transform function requested by the caller.
Group: | EWDB_API_LIB
Sub Group: | COOKED_INFRASTRUCTURE-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h

ewdb_internal_GetTransformFunctionDesc()

Prototype: |
int ewdb_internal_GetTransformFunctionDesc( | EWDBid idCookedTF, char * szCookedTFDesc);
Source File: | src/oracle/schema-working/src/infra/ewdb_internal_GetTransformFunctionDesc.c
Description: | Retrieves the description for a Transform function from the DB, using the CookedTF record identifier (idCookedTF).
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success
PARAMETER INFO
Parameter | Type | Description
idCookedTF | EWDBid | Database ID for the cooked infrastructure record.
szCookedTFDesc | char * | Output description for this record. This field should point to a buffer (allocated by the caller) of atleast sizeof(EWDB_TransformFunctionStruct.szCookedTFDesc) bytes.
Group: | EWDB_API_LIB
Sub Group: | COOKED_INFRASTRUCTURE-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h

ewdb_internal_SetChanParams()

Prototype: |
int ewdb_internal_SetChanParams( | EWDBid idChan, double tOn, double tOff, EWDBid idCompT, EWDBid idDeviceSlot, int iPlexor, EWDBid * pidChanT, char * szComment);
Source File: | src/oracle/schema-working/src/infra/ewdb_internal_SetChanParams.c
Description: | Function sets the variable parameters of a channel for a given time interval. Variable parameters include the starting device in the channel in the waveforms to ground motion direction, and the component that the channel is associated with. The function will write the DB ID of the newly created/updated channel time interval record to pidChanT.
Note: | idDeviceSlot/iPlexor are currently ignored due to a lack of infrastructure schema. Please set the values to 0. The time interval (tOn-tOff) must be a subset of the time validity range of idCompT.
RETURN CODE INFO
Return Type: | int
Return Value | Description
EWDB_RETURN_FAILURE | Fatal error. See logfile for details.
EWDB_RETURN_SUCCESS | Success.
PARAMETER INFO
Parameter | Type | Description
idChan | EWDBid | The DB ID of the channel the caller wants to set parameters for.
tOn | double | The start of the time interval for which the caller wants the channel parameters to be valid. Expressed as seconds since 1970.
tOff | double | The end of the time interval for which the caller wants the channel parameters to be valid. Expressed as seconds since 1970.
idCompT | EWDBid | The DB ID of the component time interval that the caller wants to associate with the channel.
idDeviceSlot | EWDBid | The DB ID of the first device slot in the channel(in order of finished waveforms -> ground motion).
iPlexor | int | The connection pin on the first device slot in the channel, that corresponds to this channel. (More than one channel can come from the same device/device slot. See raw infrastructure documentation if available).
pidChanT | EWDBid * | A pointer to an EWDBid where the function will write the DB ID of the updated or newly created channel tme interval(ChanT).
szComment | char * | Optional comment regarding the channel time interval(ChanT). It may be blank, and should be a maximum of 4k characters. It may not be NULL!
Group: | EWDB_API_LIB
Sub Group: | COOKED_INFRASTRUCTURE-INTERNAL
Language: | C
Location: | ./src/oracle/schema-working/src/include/internal/ewdb_internal_functions.h