Classes | Public Member Functions

FCam::F2::Flash Class Reference

An F2 specific Flash Device for Phidgets triggered flash units. More...

#include <Flash.h>

Inheritance diagram for FCam::F2::Flash:
Inheritance graph
[legend]
Collaboration diagram for FCam::F2::Flash:
Collaboration graph
[legend]

List of all members.

Classes

class  StrobeStartAction
 This action marks the beginning of a strobing sequence on a strobe enabled flash unit. More...
class  StrobeStopAction
 This action marks the end of a strobing sequence on a strobe enabled flash unit. More...

Public Member Functions

 Flash (int phidgetOutputIndex=0)
 The Flash constructor initializes a PhidgetDevice on behalf of the Flash and registers the Phidget interface kit output that must be set true to fire the flash.
int minDuration ()
 Minimum flash duration in microseconds.
int maxDuration ()
 Maximum flash duration in microseconds.
float minBrightness ()
 The minimum brightness setting of the flash.
float maxBrightness ()
 The maximum brightness setting the flash.
void fire (float brightness, int duration)
 Without reverse engineering flash communication protocols, the best we can do is to simply trigger the flash at maximum brightness and unknown duration.
int fireLatency ()
 The flash does not actually fire until 127ms after the call to fire().
void startStrobe ()
 For flashes that feature strobe modes, this method begins a strobing sequence.
void stopStrobe ()
 For flashes that feature strobe modes, this method ends a strobing sequence.
float getBrightness (Time)
 What was the brightness of the flash at some time in the recent past.
void tagFrame (FCam::Frame)
 Attach tags describing the state of the flash during a frame to a Frame.
 Flash (int phidgetOutputIndex=0)
 The Flash constructor initializes a PhidgetDevice on behalf of the Flash and registers the Phidget interface kit output that must be set true to fire the flash.
int minDuration ()
 Minimum flash duration in microseconds.
int maxDuration ()
 Maximum flash duration in microseconds.
float minBrightness ()
 The minimum brightness setting of the flash.
float maxBrightness ()
 The maximum brightness setting the flash.
void fire (float brightness, int duration)
 Without reverse engineering flash communication protocols, the best we can do is to simply trigger the flash at maximum brightness and unknown duration.
int fireLatency ()
 The flash does not actually fire until 127ms after the call to fire().
void startStrobe ()
 For flashes that feature strobe modes, this method begins a strobing sequence.
void stopStrobe ()
 For flashes that feature strobe modes, this method ends a strobing sequence.
float getBrightness (Time)
 What was the brightness of the flash at some time in the recent past.
void tagFrame (FCam::Frame)
 Attach tags describing the state of the flash during a frame to a Frame.

Detailed Description

An F2 specific Flash Device for Phidgets triggered flash units.

Definition at line 18 of file Flash.h.


Member Function Documentation

float FCam::F2::Flash::minBrightness (  )  [inline, virtual]

The minimum brightness setting of the flash.

The units are platform specific.

Implements FCam::Flash.

Definition at line 33 of file Flash.h.

float FCam::F2::Flash::maxBrightness (  )  [inline, virtual]

The maximum brightness setting the flash.

The units are platform specific.

Implements FCam::Flash.

Definition at line 34 of file Flash.h.

void FCam::F2::Flash::fire ( float  brightness,
int  duration 
) [virtual]

Without reverse engineering flash communication protocols, the best we can do is to simply trigger the flash at maximum brightness and unknown duration.

For now, the arguments to this method are ignored.

Implements FCam::Flash.

Definition at line 65 of file Flash.cpp.

float FCam::F2::Flash::getBrightness ( Time  t  )  [inline, virtual]

What was the brightness of the flash at some time in the recent past.

Implements FCam::Flash.

Definition at line 53 of file Flash.h.

void FCam::F2::Flash::tagFrame ( FCam::Frame   )  [virtual]

Attach tags describing the state of the flash during a frame to a Frame.

You should never need to call this function - it's done for you by the Sensor.

Implements FCam::Flash.

Definition at line 77 of file Flash.cpp.

float FCam::F2::Flash::minBrightness (  )  [inline, virtual]

The minimum brightness setting of the flash.

The units are platform specific.

Implements FCam::Flash.

Definition at line 33 of file Flash.h.

float FCam::F2::Flash::maxBrightness (  )  [inline, virtual]

The maximum brightness setting the flash.

The units are platform specific.

Implements FCam::Flash.

Definition at line 34 of file Flash.h.

void FCam::F2::Flash::fire ( float  brightness,
int  duration 
) [virtual]

Without reverse engineering flash communication protocols, the best we can do is to simply trigger the flash at maximum brightness and unknown duration.

For now, the arguments to this method are ignored.

Implements FCam::Flash.

float FCam::F2::Flash::getBrightness ( Time  t  )  [inline, virtual]

What was the brightness of the flash at some time in the recent past.

Implements FCam::Flash.

Definition at line 53 of file Flash.h.

void FCam::F2::Flash::tagFrame ( FCam::Frame   )  [virtual]

Attach tags describing the state of the flash during a frame to a Frame.

You should never need to call this function - it's done for you by the Sensor.

Implements FCam::Flash.


The documentation for this class was generated from the following files: