FCam::N900::Sensor Class Reference

The N900 Image Sensor class. More...

#include <Sensor.h>

Inheritance diagram for FCam::N900::Sensor:

Inheritance graph
[legend]
Collaboration diagram for FCam::N900::Sensor:

Collaboration graph
[legend]

List of all members.

Public Member Functions

void capture (const FCam::Shot &)
 Queue up the next shot.
void capture (const std::vector< FCam::Shot > &)
 Queue up a burst of shots.
void stream (const FCam::Shot &s)
 Set a shot to be captured when the sensor isn't busy capturing anything else.
void stream (const std::vector< FCam::Shot > &)
 Set a burst to be captured whenever the sensor isn't busy capturing anything else.
bool streaming ()
 Is there a shot or burst currently streaming?
void stopStreaming ()
 Stop the sensor from streaming a shot or burst set with stream.
int getRollingShutterTime (const Shot &) const
 The time difference between the first line exposing and the last line in microseconds, for given shot parameters.
int framesPending () const
 How many frames are in the frame queue (i.e., how many times can you call getFrame before it blocks?
int shotsPending () const
 How many shots are pending.
BayerPattern getBayerPattern () const
 Get the bayer pattern of this sensor when in raw mode.
const float * getXYZToRawColorMatrixTungsten () const
 The 3x3 color matrix mapping under Tungsten lighting.
const float * getXYZToRawColorMatrixDaylight () const
 The 3x3 color matrix mapping under daylight.
const std::string & getManufacturer ()
 The camera's manufacturer.
const std::string & getModel ()
 The camera's model.
FCam::Frame::Ptr getFrame ()
 Get the next frame.


Detailed Description

The N900 Image Sensor class.

It takes vanilla shots and returns vanilla frames. See the base class documentation for the semantics of its methods.

Definition at line 23 of file Sensor.h.


Member Function Documentation

void FCam::N900::Sensor::capture ( const FCam::Shot  )  [virtual]

Queue up the next shot.

Makes a deep copy of the argument.

Implements FCam::Sensor.

Definition at line 25 of file Sensor.cpp.

void FCam::N900::Sensor::capture ( const std::vector< FCam::Shot > &   )  [virtual]

Queue up a burst of shots.

Makes a deep copy of the argument.

Implements FCam::Sensor.

Definition at line 41 of file Sensor.cpp.

void FCam::N900::Sensor::stream ( const FCam::Shot s  )  [virtual]

Set a shot to be captured when the sensor isn't busy capturing anything else.

Makes a deep copy of the argument.

Implements FCam::Sensor.

Definition at line 62 of file Sensor.cpp.

void FCam::N900::Sensor::stream ( const std::vector< FCam::Shot > &   )  [virtual]

Set a burst to be captured whenever the sensor isn't busy capturing anything else.

Makes a deep copy of the argument.

Implements FCam::Sensor.

Definition at line 72 of file Sensor.cpp.

void FCam::N900::Sensor::stopStreaming (  )  [virtual]

Stop the sensor from streaming a shot or burst set with stream.

The sensor will continue to run.

Implements FCam::Sensor.

Definition at line 90 of file Sensor.cpp.

int FCam::N900::Sensor::getRollingShutterTime ( const Shot  )  const [virtual]

The time difference between the first line exposing and the last line in microseconds, for given shot parameters.

Implements FCam::Sensor.

Definition at line 107 of file Sensor.cpp.

int FCam::N900::Sensor::shotsPending (  )  const [virtual]

How many shots are pending.

This includes frames in the frame queue, shots currently in the pipeline, and shots in the capture queue. Stop streaming (stopStreaming) and get frames (getFrame) until this hits zero to completely drain the system.

Implements FCam::Sensor.

Definition at line 128 of file Sensor.cpp.

BayerPattern FCam::N900::Sensor::getBayerPattern (  )  const [inline, virtual]

Get the bayer pattern of this sensor when in raw mode.

Implements FCam::Sensor.

Definition at line 41 of file Sensor.h.

const float* FCam::N900::Sensor::getXYZToRawColorMatrixTungsten (  )  const [inline, virtual]

The 3x3 color matrix mapping under Tungsten lighting.

It maps from XYZ to this sensor's raw color space under standard illuminant A (just under 3000K). Given in row-major order.

Implements FCam::Sensor.

Definition at line 43 of file Sensor.h.

const float* FCam::N900::Sensor::getXYZToRawColorMatrixDaylight (  )  const [inline, virtual]

The 3x3 color matrix mapping under daylight.

It maps from XYZ to this sensor's raw color space under standard illuminant D65 (6500K). Given in row-major order.

Implements FCam::Sensor.

Definition at line 44 of file Sensor.h.

const std::string& FCam::N900::Sensor::getManufacturer (  )  [inline, virtual]

The camera's manufacturer.

(e.g. Canon).

Implements FCam::Sensor.

Definition at line 46 of file Sensor.h.

const std::string& FCam::N900::Sensor::getModel (  )  [inline, virtual]

The camera's model.

Should also include manufacturer (e.g. Canon 400D).

Implements FCam::Sensor.

Definition at line 47 of file Sensor.h.

Frame::Ptr FCam::N900::Sensor::getFrame (  )  [virtual]

Get the next frame.

We promise that precisely one frame will come back per time capture is called. A reference-counted shared pointer object is returned, so you don't need to worry about deleting it.

Implements FCam::Sensor.

Definition at line 96 of file Sensor.cpp.


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

Generated on Mon Jan 18 20:48:15 2010 for FCam by  doxygen 1.5.6