Camera Parameters


Functions

BOOL dvcGetAuxTTL (HANDLE hDevice, PBOOL pManual, PBOOL pHi)
BOOL dvcGetExposeInterval (HANDLE hDevice, Int32 nMode, Int32 nBin, Int32 nScanRate, double *pInterval)
BOOL dvcGetExposeMax (HANDLE hDevice, Int32 nMode, Int32 nBin, Int32 nScanRate, double *pMax)
double dvcGetExposeMsec (HANDLE hDevice)
BOOL dvcGetExtReset (HANDLE hDevice)
BOOL dvcGetExtVideo (HANDLE hDevice)
BOOL dvcGetGain (HANDLE hDevice, PInt32 pGain)
BOOL dvcGetGaindB (HANDLE hDevice, double *pdGaindB)
BOOL dvcGetGaindBRange (HANDLE hDevice, double *pMinGain, double *pMaxGain, double *pGranularity)
BOOL dvcGetGainOffset (HANDLE hDevice, PInt32 pGain, PInt32 pOffset)
BOOL dvcGetIntensifierExtTrigger (HANDLE hDevice)
BOOL dvcGetLineFrameTime (HANDLE hDevice, double *pLine, double *pFrame)
BOOL dvcGetNonOverlappedExpose (HANDLE hDevice, PBOOL pbOnOff)
BOOL dvcGetOffset (HANDLE hDevice, PInt32 pOffset)
BOOL dvcGetOffsetFS (HANDLE hDevice, double *pdOffsetFS)
BOOL dvcGetOffsetFSRange (HANDLE hDevice, double *pMinOffset, double *pMaxOffset, double *pGranularity)
BOOL dvcGetParm (HANDLE hDevice, UInt32 aParm, PInt32 pValue)
BOOL dvcGetParmRange (HANDLE hDevice, UInt32 aParm, PInt32 pMin, PInt32 pMax, PInt32 pGranularity, PInt32 pDefault)
double dvcGetPixelClock (HANDLE hDevice)
BOOL dvcGetPort (HANDLE hDevice, Int32 nPortID, PInt32 pValue)
BOOL dvcGetPreAmp (HANDLE hDevice, PBOOL pOnOff, PInt32 pWhen)
BOOL dvcGetScanRate (HANDLE hDevice, PInt32 pSlowScan)
BOOL dvcGetStreamState (HANDLE hDevice, PInt32 pState, UPInt32 pRemainingFrames)
BOOL dvcGetStrobe (HANDLE hDevice, PInt32 pStrobe)
BOOL dvcGetStrobeDelay (HANDLE hDevice, double *pdDelay)
BOOL dvcSetAuxTTL (HANDLE hDevice, BOOL bManual, BOOL bHi)
double dvcSetExposeMsec (HANDLE hDevice, double dMilliSeconds)
BOOL dvcSetExtReset (HANDLE hDevice, BOOL bOnOff)
BOOL dvcSetExtVideo (HANDLE hDevice, BOOL bOnOff)
BOOL dvcSetGain (HANDLE hDevice, Int32 nGain)
BOOL dvcSetGaindB (HANDLE hDevice, double dGaindB)
BOOL dvcSetGainOffset (HANDLE hDevice, Int32 nGain, Int32 nOffset)
BOOL dvcSetIntensifierExtTrigger (HANDLE hDevice, BOOL bOnOff)
BOOL dvcSetNonOverlappedExpose (HANDLE hDevice, BOOL bOnOff)
BOOL dvcSetOffset (HANDLE hDevice, Int32 nOffset)
BOOL dvcSetOffsetFS (HANDLE hDevice, double dOffsetFS)
BOOL dvcSetParm (HANDLE hDevice, UInt32 aParm, Int32 nValue)
BOOL dvcSetPort (HANDLE hDevice, Int32 nPortID, Int32 nValue)
BOOL dvcSetPreAmp (HANDLE hDevice, BOOL bOnOff, Int32 nWhen)
BOOL dvcSetScanRate (HANDLE hDevice, Int32 nScanRate)
BOOL dvcSetStrobe (HANDLE hDevice, Int32 eStrobe)
BOOL dvcSetStrobeDelay (HANDLE hDevice, double dDelay)

Function Documentation

BOOL dvcGetAuxTTL ( HANDLE  hDevice,
PBOOL  pManual,
PBOOL  pHi 
)

Returns the status for aux connector for DVC 710

Parameters:
hDevice handle from dvcOpenCamera().
pManual TRUE if strobe output is under manual control, or FALSE if strobe output cycles with each frame.
pHi returns the state of strobe out when pManual is TRUE.
Returns:
TRUE if 710 and able to read the AUX connector status.
See also:
dvcSetAuxTTL().

BOOL dvcGetExposeInterval ( HANDLE  hDevice,
Int32  nMode,
Int32  nBin,
Int32  nScanRate,
double *  pInterval 
)

Get the exposure granularity for a given exposure mode, binning and scan rate.

Parameters:
hDevice returned from dvcOpenCamera().
nMode camera exposure mode or -1 for the current state.
nBin camera binning index or -1 for the current state.
nScanRate camera scan rate or -1 for the current state.
pInterval returns with the granularity of the exposure time.
Examples:
FullScreen.cpp.

BOOL dvcGetExposeMax ( HANDLE  hDevice,
Int32  nMode,
Int32  nBin,
Int32  nScanRate,
double *  pMax 
)

Parameters:
hDevice returned from dvcOpenCamera().
nMode camera exposure mode or -1 for the current state.
nBin camera binning index or -1 for the current state.
nScanRate camera scan rate or -1 for the current state.
pMax returns with the maximum exposure time.
Get the exposure granularity for a given exposure mode, binning and scan rate.

double dvcGetExposeMsec ( HANDLE  hDevice  ) 

Parameters:
hDevice handle from dvcOpenCamera().
Returns:
the current camera exposure time in milliseconds
When a camera is triggered using the dvcTriggerTimed trigger mode in dvcSnapShot() or dvcStartSequence(), the exposure time is determined by the internal line and frame counters of the readout. Changing the readout area with dvcSetBinning() or dvcSetROI(), or the ADC clock with dvcSetScanRate() may change the periods of the line and frame counters.
See also:
dvcSetExposeMsec().
Examples:
FullScreen.cpp, RamCapture.cpp, and testEvent.cpp.

BOOL dvcGetExtReset ( HANDLE  hDevice  ) 

Returns state for external reset (VRST_INT) inputs.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
Returns:
TRUE if VRST_INT inputs are enabled.

BOOL dvcGetExtVideo ( HANDLE  hDevice  ) 

Returns state for external video output (DVC 710 only)

Parameters:
hDevice camera handle returned from dvcOpenCamera().
Returns:
TRUE if a DVC 710 camera and the video output is enabled.

BOOL dvcGetGain ( HANDLE  hDevice,
PInt32  pGain 
)

Get the camera's current gain setting.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
pGain returns the current gain index.
Returns:
TRUE if successful, FALSE if hDevice is not a legal camera handle.
See also:
dvcGetParmRange().

dvcGetGaindB() to get the gain in decibels independently of the camera model.

Examples:
FullScreen.cpp.

BOOL dvcGetGaindB ( HANDLE  hDevice,
double *  pdGaindB 
)

Parameters:
hDevice camera handle returned from dvcOpenCamera().
pdGaindB returns with the camera's current gain setting in dB.
See also:
dvcSetGaindB() , dvcGetGain(), dvcGetGaindBRange().

BOOL dvcGetGaindBRange ( HANDLE  hDevice,
double *  pMinGain,
double *  pMaxGain,
double *  pGranularity 
)

Returns the range of gain settings and interval for a camera.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
pMinGain returns the lowest gain setting for the camera.
pMaxGain returns the highest gain setting for the camera.
pGranularity returns the granularity of gain changes.

BOOL dvcGetGainOffset ( HANDLE  hDevice,
PInt32  pGain,
PInt32  pOffset 
)

Parameters:
hDevice returned from dvcOpenCamera().
pGain the returned gain index.
pOffset the returned offset index.
Convenience function to get the gain and offset simultaneously.

BOOL dvcGetIntensifierExtTrigger ( HANDLE  hDevice  ) 

Return the state for VRST_INT trigger for an Intensifier

Parameters:
hDevice camera handle returned from dvcOpenCamera().
Returns:
TRUE if an Intensifier's MCP is gated by the VRST_INT signal.

BOOL dvcGetLineFrameTime ( HANDLE  hDevice,
double *  pLine,
double *  pFrame 
)

returns the line and frame times for transferring images.

Parameters:
hDevice returned from dvcOpenCamera().
pLine time in milliseconds to readout a single line.
pFrame time in milliseconds to readout an entire frame.

BOOL dvcGetNonOverlappedExpose ( HANDLE  hDevice,
PBOOL  pbOnOff 
)

Return the state for non-overlapped exposure modes.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
pbOnOff returns TRUE if a camera supports non-overlapped expose and readout and this mode is enabled.

BOOL dvcGetOffset ( HANDLE  hDevice,
PInt32  pOffset 
)

Get the camera's current offset setting.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
pOffset returns the current offset index.
Examples:
FullScreen.cpp.

BOOL dvcGetOffsetFS ( HANDLE  hDevice,
double *  pdOffsetFS 
)

Get the camera's current offset setting as a fraction of full scale.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
pdOffsetFS returns with the current offset as a fraction of the full scale output of the ADC.

BOOL dvcGetOffsetFSRange ( HANDLE  hDevice,
double *  pMinOffset,
double *  pMaxOffset,
double *  pGranularity 
)

Returns the range of offset settings and interval for a camera.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
pMinOffset returns the lowest offset setting for the camera.
pMaxOffset returns the highest offset setting for the camera.
pGranularity returns the granularity of offset changes.

BOOL dvcGetParm ( HANDLE  hDevice,
UInt32  aParm,
PInt32  pValue 
)

Get the current value of a control parameter.

Parameters:
hDevice returned from dvcOpenCamera().
aParm the attribute to be set.
pValue returns the current value of aParm.

BOOL dvcGetParmRange ( HANDLE  hDevice,
UInt32  aParm,
PInt32  pMin,
PInt32  pMax,
PInt32  pGranularity,
PInt32  pDefault 
)

Returns the range and default value of a given control parameter.

Parameters:
hDevice returned from dvcOpenCamera().
aParm one of the following attributes from dvcdefs.h; 
    typedef enum {
        aGain     = 0,
        aOffset,
        aBinning,
        aScanRate,
        aExposureMode,
        aExposureDuration,
        aIntensifierMode,
        aIntensifierGain,
        aIntensifierDelay,
        aIntensifierDuration,
        aFilterWheelPosition,
        aFilterWheelSpeed,
        aExternalVideo,
        aEnableROI,
        aROITop,
        aROIBottom,
        aIllegalAttr
    }  dvcCameraParameters ;
pMin returns filled with the minimum value of the attribute.
pMax returns filled with the maximum value of the attribute.
pGranularity returns filled with the incremental value of the attribute.
pDefault returns filled with the default value of the attribute.
See also:
dvcSetParm(), dvcGetParm().
Examples:
FullScreen.cpp, and RamCapture.cpp.

double dvcGetPixelClock ( HANDLE  hDevice  ) 

get the camera's pixel clock frequency.

Parameters:
hDevice handle returned from dvcOpenCamera().
Returns:
frequency of the camera's pixel clock in HZ.

BOOL dvcGetPort ( HANDLE  hDevice,
Int32  nPortID,
PInt32  pValue 
)

Returns the state of a centronics data port ( 1394 interfaces only )

Parameters:
hDevice handle returned from dvcOpenCamera().
nPortID address of the port to read
pValue returns with the bit mask of the data for the given nPortID.
Returns:
TRUE if the port can be read.
Requires entering an attribute value pair in the dvcAPI.ini file ;
 PortIOEnabled=1
before this function is enabled.

        nPortID         pValue returns with;
        0x378           the bit mask of the centronics LPT1: pins 2-9.
        0x379           the control signals 
        0x37A           the status signals of LPT1:.
See also:
dvcSetPort().

BOOL dvcGetPreAmp ( HANDLE  hDevice,
PBOOL  pOnOff,
PInt32  pWhen 
)

Disable or enable the preamplifier to reduce diode glow during long exposures.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
pOnOff returns TRUE if long exposures disable the preamp.
pWhen returns the exposure time when the preamp is disabled.
Get the state and exposure time when the camera's pre-amp is disabled to reduce diode glow.

BOOL dvcGetScanRate ( HANDLE  hDevice,
PInt32  pSlowScan 
)

Get the current scan rate for the camera.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
pSlowScan returns the current index.
See also:
dvcSetScanRate(), dvcGetParmRange().

BOOL dvcGetStreamState ( HANDLE  hDevice,
PInt32  pState,
UPInt32  pRemainingFrames 
)

While acquistions are in progress, this function returns the state of the DMA and number of frames remaining to be transferred. Stream states

Parameters:
hDevice camera handle returned from dvcOpenCamera().
pState returns the current state as one of the following 
    DVC_IDLE              = 0,         // No active transfers ..
    DVC_EXPOSING          = 1,         // Exposure queued or waiting
    DVC_READING_DATA      = 2,         // Transferring data
    DVC_READ_COMPLETE     = 4,         // DMA complete
    DVC_DMA_IN_PROGRESS   = 8,         // DMA started..
    DVC_START_SEQUENCE    = 16,        // Sequence pending
    DVC_SEQUENCE_COMPLETE = 32,        // Sequence finished
    DVC_SEQUENCE_ABORTED  = 64,        // Sequence stopped
    DVC_SYNC_ERR          = 0x8000000  // data stream out of sync..
pRemainingFrames returns the frames remaining to be acquired.
See also:
dvcGetStatus().

BOOL dvcGetStrobe ( HANDLE  hDevice,
PInt32  pStrobe 
)

Get the auxillary strobe output state.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
pStrobe returns the strobe state as ;
  dvcStrobeLow strobe output always at low TTL level.
  dvcStrobeHigh strobe output always at high TTL level.
  dvcStrobeActiveHigh strobe output cycles high during exposures.
  dvcStrobeActiveLow strobe output cycles low during sequences.
See also:
dvcSetStrobe().

BOOL dvcGetStrobeDelay ( HANDLE  hDevice,
double *  pdDelay 
)

Get the delay in milliseconds for dvcStrobeActiveLow.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
pdDelay returns the delay for setting the strobe output in milliseconds.

BOOL dvcSetAuxTTL ( HANDLE  hDevice,
BOOL  bManual,
BOOL  bHi 
)

Set the strobe output for aux connector for DVC 710

Parameters:
hDevice handle from dvcOpenCamera().
bManual TRUE to set strobe output to manual control, or FALSE to set strobe output to cycle with each frame.
bHi sets the state of strobe out when bManual is TRUE.
Returns:
TRUE if 710 and able to write the AUX connector strobe out.
See also:
dvcGetAuxTTL().

double dvcSetExposeMsec ( HANDLE  hDevice,
double  dMilliSeconds 
)

Set the exposure time in milliseconds.

Parameters:
hDevice handle from dvcOpenCamera().
dMilliSeconds the time to expose in milliseconds.
Returns:
the actual time set.
See also:
dvcGetExposeMsec(), dvcSnapShot(), dvcStartSequence().
In cases were the requested time is not available, the exposure time is to the nearest setting possible. On earlier DVC 131X and 1412 series cameras, exposure times greater than a frame time could only be set at intervals of frame times for continuous overlapped exposures. DVC 340, 2000 and 4000 camera models have an exposure granularity equal to the period of the line clock.
Examples:
avgdvc.cpp, FullScreen.cpp, MultiCamera.cpp, RamCapture.cpp, snapdvc.cpp, and testEvent.cpp.

BOOL dvcSetExtReset ( HANDLE  hDevice,
BOOL  bOnOff 
)

Enable camera resets with VRST_INT input of AUX connector

Parameters:
hDevice return from dvcOpenCamera().
bOnOff TRUE if VRST_INT input is enabled.
See also:
dvcGetExtReset().

BOOL dvcSetExtVideo ( HANDLE  hDevice,
BOOL  bOnOff 
)

Enable external video output (DVC 710 only)

Parameters:
hDevice camera handle returned from dvcOpenCamera().
bOnOff TRUE to enable video out, and FALSE to disable.
See also:
dvcGetExtVideo().

BOOL dvcSetGain ( HANDLE  hDevice,
Int32  nGain 
)

Sets the gain on the camera's analog to digital converter. The gain is a multiplicative component of the ADC, i.e., DN = (light level) x gain + offset.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
nGain is a camera dependent gain setting. Increasing values increase the output DN or graylevel for a given light level by changing the slope.
See also:
dvcGetParmRange() to determine the range and default values for nGain.

dvcSetGaindB() to set the gain in decibels independently of the camera model.

Examples:
avgdvc.cpp, FullScreen.cpp, MultiCamera.cpp, RamCapture.cpp, snapdvc.cpp, and testEvent.cpp.

BOOL dvcSetGaindB ( HANDLE  hDevice,
double  dGaindB 
)

Parameters:
hDevice camera handle returned from dvcOpenCamera().
dGaindB is the gain in decibels and is internally converted to the camera dependent gain setting. Each 6.0 dB change doubles or halves the output DN for a given light level. If the value is out of the range the camera supports, the minimum or maximum value is set. The granularity varies depending on the ADC design of a camera. All values are rounded to the closest setting the camera supports.
See also:
dvcGetGaindB() , dvcSetGain(), dvcGetGaindBRange().

BOOL dvcSetGainOffset ( HANDLE  hDevice,
Int32  nGain,
Int32  nOffset 
)

Convenience function to set the gain and offset simultaneously.

Parameters:
hDevice returned from dvcOpenCamera().
nGain the gain index to set.
nOffset the offset index to set.

BOOL dvcSetIntensifierExtTrigger ( HANDLE  hDevice,
BOOL  bOnOff 
)

Enable VRST_INT triggers for an Intensifier

Parameters:
hDevice camera handle returned from dvcOpenCamera().
bOnOff TRUE enables VRST_INT to gate an Intensifier's MCP.

BOOL dvcSetNonOverlappedExpose ( HANDLE  hDevice,
BOOL  bOnOff 
)

Enable non-overlapped exposure modes.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
bOnOff TRUE enables non-overlapped expose and readout modes.
DVC 340, 2000 and 400 cameras operate in both overlapped (default) and non-overlapped expose and readout. Passing bOnOff as TRUE to this function disables the overlapped expose and readout.

BOOL dvcSetOffset ( HANDLE  hDevice,
Int32  nOffset 
)

Sets the offset or bias voltage for the camera's analog to digital converter. The offset is an additive component for the ADC, i.e., DN = (light level) x gain + offset.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
nOffset is a camera dependent bias setting. Increasing values increase the output DN or graylevel for a given light level by changing the intercept.
See also:
dvcGetParmRange() to determine the range and default values for nOffset.

dvcSetOffsetFS() to set the offset as a fraction of full scale independently of the camera model.

Examples:
avgdvc.cpp, FullScreen.cpp, MultiCamera.cpp, RamCapture.cpp, and snapdvc.cpp.

BOOL dvcSetOffsetFS ( HANDLE  hDevice,
double  dOffsetFS 
)

Sets the camera offset as a fraction of full scale. Unlike dvcSetOffset(), dvcSetOffsetFS()

Parameters:
hDevice camera handle returned from dvcOpenCamera().
dOffsetFS sets the current offset.
See also:
dvcGetOffsetFS(), dvcSetOffset().

BOOL dvcSetParm ( HANDLE  hDevice,
UInt32  aParm,
Int32  nValue 
)

Sets a control parameter to a given value.

Parameters:
hDevice returned from dvcOpenCamera().
aParm the attribute to be set.
nValue the value to set for aParm.
Returns:
FALSE if aParm or nValue is out of range or hDevice is not an open camera.
See also:
dvcGetParmRange(), dvcGetParm().

BOOL dvcSetPort ( HANDLE  hDevice,
Int32  nPortID,
Int32  nValue 
)

Sets the state of a centronics data port ( 1394 interfaces only )

Parameters:
hDevice handle returned from dvcOpenCamera().
nPortID address of the port to write ( 0x378 for LPT1: ).
nValue the bit mask of the data to write to nPortID.
Returns:
TRUE if the port can be written.
Requires entering an attribute value pair in the dvcAPI.ini file ; 
 PortIOEnabled=1
before this function is enabled. With nPortID equal to 0x378, the bit mask given by nValue is written to the centronics port LPT1:, pins 2-9. May require running Setup before booting to reset the line printer port to enable latched outputs.
See also:
dvcGetPort().

BOOL dvcSetPreAmp ( HANDLE  hDevice,
BOOL  bOnOff,
Int32  nWhen 
)

Enable or disable the preamp to the ADC during long exposure times.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
bOnOff TRUE disables the preamp during long exposures.
nWhen sets the exposure time in milliseconds when the preamp is disabled.
See also:
dvcGetPreAmp().
On powerup, DVC 1412, 340, 2000 and 4000 cameras switch off the preamplifier when the expose time exceeds 10 seconds. The preamp emits a low photon count (diode glow) in the upper left corner of sensor visisble during long exposures.

BOOL dvcSetScanRate ( HANDLE  hDevice,
Int32  nScanRate 
)

Sets the frequency of the ADC. On DVC 2000 and 4000 series cameras, this function selects one of two analog to digital converters, [0] for 20 MHz and [1] for 40 MHz. On DVC 131X and 1412 series cameras, the clock frequency of the ADC is reduced by a factor of 2 for each incremental value.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
nScanRate is [0] for the slow, 20 MHZ ADC and [1] for the fast 40 MHz ADC on DVC 2000 and 4000 cameras. On 131X and 1412 cameras, the ADC clock is 18, 9, 4.5, and 2.25 MHz for values of [0],[1],[2] and [3].
See also:
dvcGetScanRate(), dvcGetParmRange().

BOOL dvcSetStrobe ( HANDLE  hDevice,
Int32  eStrobe 
)

Set the auxillary strobe output state.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
eStrobe sets the strobe state with ;
  dvcStrobeLow strobe output always at low TTL level.
  dvcStrobeHigh strobe output always at high TTL level.
  dvcStrobeActiveHigh strobe output cycles high during exposures.
  dvcStrobeActiveLow strobe output cycles low during sequences.
See also:
dvcGetStrobe().

BOOL dvcSetStrobeDelay ( HANDLE  hDevice,
double  dDelay 
)

Set the delay in milliseconds for dvcStrobeActiveLow.

Parameters:
hDevice camera handle returned from dvcOpenCamera().
dDelay sets the delay for setting the strobe output in milliseconds.

©DVC Company, 2006. All rights reserved.    www.dvcco.com   Created Thu Nov 16 10:07:22 2006