Class SpinnakerNET::ManagedImage

ClassList > SpinnakerNET > ManagedImage

The managed image object class.

• #include <ManagedImage.h>

Inherits the following classes: SpinnakerNET::IManagedImage

Public Attributes

Type	Name
property bool	HasChunkData
property SpinnakerNET::ImageStatus	ImageStatus

Public Attributes inherited from SpinnakerNET::IManagedImage

See SpinnakerNET::IManagedImage

Type	Name
property unsigned int	BitsPerPixel = /* multi line expression */
property unsigned int	BufferSize = /* multi line expression */
property bool	CheckCRC = /* multi line expression */
property ManagedChunkData	ChunkData = /* multi line expression */
property::System::UInt64	ChunkLayoutID = /* multi line expression */
property IntPtr	DataPtr = /* multi line expression */
property::System::UInt64	FrameID = /* multi line expression */
property bool	HasCRC = /* multi line expression */
property bool	HasChunkData = /* multi line expression */
property unsigned int	Height = /* multi line expression */
property::System::UInt64	ID = /* multi line expression */
property SpinnakerNET::ImagePayloadType	ImagePayloadType = /* multi line expression */
property unsigned int	ImageSize = /* multi line expression */
property SpinnakerNET::ImageStatus	ImageStatus = /* multi line expression */
property bool	IsInUse = /* multi line expression */
property bool	IsIncomplete = /* multi line expression */
property array< byte >	ManagedData = /* multi line expression */
property unsigned char *	NativeData = /* multi line expression */
property unsigned int	OffsetX = /* multi line expression */
property unsigned int	OffsetY = /* multi line expression */
property unsigned int	PayloadType = /* multi line expression */
property SpinnakerNET::PixelFormatEnums	PixelFormat = /* multi line expression */
property::System::String	PixelFormatName = /* multi line expression */
property unsigned char *	PrivateData = /* multi line expression */
property::System::String	SerialNumber = /* multi line expression */
property::System::UInt64	StreamIndex = /* multi line expression */
property unsigned int	Stride = /* multi line expression */
property unsigned int	TLPayloadType = /* multi line expression */
property::System::UInt64	TLPixelFormat = /* multi line expression */
property::System::UInt64	TimeStamp = /* multi line expression */
property unsigned int	ValidPayloadSize = /* multi line expression */
property unsigned int	Width = /* multi line expression */
property unsigned int	XPadding = /* multi line expression */
property unsigned int	YPadding = /* multi line expression */
property::System::Drawing::Bitmap	bitmap = /* multi line expression */
property::System::Windows::Media::Imaging::BitmapSource	bitmapsource = /* multi line expression */
property::System::Windows::Media::Imaging::WriteableBitmap	writeableBitmap = /* multi line expression */

Public Functions

Type	Name
virtual void	CalculateStatistics (ManagedImageStatistics^ statistics)
virtual void	ConvertToBitmapSource (SpinnakerNET::PixelFormatEnums format, IManagedImage^ destImage)
virtual void	ConvertToBitmapSource (SpinnakerNET::PixelFormatEnums format, IManagedImage^ destImage, SpinnakerNET::ColorProcessingAlgorithm algorithm)
virtual void	ConvertToWriteAbleBitmap (SpinnakerNET::PixelFormatEnums format, IManagedImage^ destImage)
virtual void	ConvertToWriteAbleBitmap (SpinnakerNET::PixelFormatEnums format, IManagedImage^ destImage, SpinnakerNET::ColorProcessingAlgorithm algorithm)
virtual void	DeepCopy (IManagedImage^ srcImage)
virtual unsigned int	GetBufferSize ()
	ManagedImage ()
	ManagedImage (IManagedImage^ srcImage)
	ManagedImage (System::String ^ fileName)
	ManagedImage (unsigned int width, unsigned int height, unsigned int offsetX, unsigned int offsetY, SpinnakerNET::PixelFormatEnums pixelFormat, void * pData)
	ManagedImage (unsigned int width, unsigned int height, unsigned int offsetX, unsigned int offsetY, SpinnakerNET::PixelFormatEnums pixelFormat, void * pData, SpinnakerNET::TLPayloadType dataPayloadType, size_t dataSize)
virtual void	Release ()
virtual void	ResetImage (unsigned int width, unsigned int height, unsigned int offsetX, unsigned int offsetY, SpinnakerNET::PixelFormatEnums pixelFormat)
virtual void	ResetImage (unsigned int width, unsigned int height, unsigned int offsetX, unsigned int offsetY, SpinnakerNET::PixelFormatEnums pixelFormat, void * pData)
virtual void	Save (System::String^ fileName)
virtual void	Save (System::String^ fileName, ImageFileFormat format)
virtual void	Save (System::String^ fileName, PngOption^ option)
virtual void	Save (System::String^ fileName, PpmOption^ option)
virtual void	Save (System::String^ fileName, PgmOption^ option)
virtual void	Save (System::String^ fileName, TiffOption^ option)
virtual void	Save (System::String^ fileName, JpegOption^ option)
virtual void	Save (System::String^ fileName, Jpg2Option^ option)
virtual void	Save (System::String^ fileName, BmpOption^ option)
ManagedImage	operator= (const ManagedImage% other)
virtual	~ManagedImage ()

Public Functions inherited from SpinnakerNET::IManagedImage

See SpinnakerNET::IManagedImage

Type	Name
void	CalculateStatistics (ManagedImageStatistics^ statistics)
void	ConvertToBitmapSource (SpinnakerNET::PixelFormatEnums format, IManagedImage^ destImage)
void	ConvertToBitmapSource (SpinnakerNET::PixelFormatEnums format, IManagedImage^ destImage, SpinnakerNET::ColorProcessingAlgorithm algorithm)
void	ConvertToWriteAbleBitmap (SpinnakerNET::PixelFormatEnums format, IManagedImage^ destImage)
void	ConvertToWriteAbleBitmap (SpinnakerNET::PixelFormatEnums format, IManagedImage^ destImage, SpinnakerNET::ColorProcessingAlgorithm algorithm)
void	DeepCopy (IManagedImage^ srcImage)
unsigned int	GetBufferSize ()
SpinnakerNET::ColorProcessingAlgorithm	GetColorProcessing ()
void	Release ()
void	ResetImage (unsigned int width, unsigned int height, unsigned int offsetX, unsigned int offsetY, SpinnakerNET::PixelFormatEnums pixelFormat)
void	ResetImage (unsigned int width, unsigned int height, unsigned int offsetX, unsigned int offsetY, SpinnakerNET::PixelFormatEnums pixelFormat, void * pData)
void	Save (::System::String^ fileName)
void	Save (::System::String^ fileName, ImageFileFormat format)
void	Save (::System::String^ fileName, PngOption^ option)
void	Save (::System::String^ fileName, PpmOption^ option)
void	Save (::System::String^ fileName, PgmOption^ option)
void	Save (::System::String^ fileName, TiffOption^ option)
void	Save (::System::String^ fileName, JpegOption^ option)
void	Save (::System::String^ fileName, Jpg2Option^ option)
void	Save (::System::String^ fileName, BmpOption^ option)

Public Attributes Documentation

variable HasChunkData

virtual property bool SpinnakerNET::ManagedImage::HasChunkData;

Checks if the image contains chunk data

Returns:

Returns true if image contains chunk data and false otherwise.

---

variable ImageStatus

virtual property SpinnakerNET::ImageStatus SpinnakerNET::ManagedImage::ImageStatus;

Returns data integrity status of the image returned from GetNextImage()

Returns:

Returns whether image has any data integrity issues.

---

Public Functions Documentation

function CalculateStatistics

virtual void SpinnakerNET::ManagedImage::CalculateStatistics (
    ManagedImageStatistics ^ statistics
) 

Calculates the statistics associated with an image. In order to collect statistics for a particular channel, the enabled flag for the channel must be set to true. Statistics can only be collected for images in Mono8, Mono16, RGB, RGBU, BGR and BGRU.

Parameters:

• statistics The ManagedImageStatistics object to hold the statistics.

Implements SpinnakerNET::IManagedImage::CalculateStatistics

---

function ConvertToBitmapSource [1/2]

virtual void SpinnakerNET::ManagedImage::ConvertToBitmapSource (
    SpinnakerNET::PixelFormatEnums format,
    IManagedImage ^ destImage
) 

Converts the current image buffer to the specified output pixel format, stores the result and populates the BitmapSource structure in destination image. The destination image does not need to be configured in any way before the call is made.

See also: PixelFormatEnums

Parameters:

• format The output pixel format.
• destImage Destination image.

Implements SpinnakerNET::IManagedImage::ConvertToBitmapSource

---

function ConvertToBitmapSource [2/2]

virtual void SpinnakerNET::ManagedImage::ConvertToBitmapSource (
    SpinnakerNET::PixelFormatEnums format,
    IManagedImage ^ destImage,
    SpinnakerNET::ColorProcessingAlgorithm algorithm
) 

Converts the current image buffer to the specified output pixel format using specified color processing algorithm, stores the result and populates the BitmapSource structure in destination image. The destination image does not need to be configured in any way before the call is made.

See also: PixelFormatEnums

See also: ColorProcessingAlgorithm

Parameters:

• format The output pixel format.
• destImage Destination image.
• algorithm Color processing algorithm for producing the destImage.

Implements SpinnakerNET::IManagedImage::ConvertToBitmapSource

---

function ConvertToWriteAbleBitmap [1/2]

virtual void SpinnakerNET::ManagedImage::ConvertToWriteAbleBitmap (
    SpinnakerNET::PixelFormatEnums format,
    IManagedImage ^ destImage
) 

Converts the current image buffer to the specified output pixel format, stores the result and populates the WriteAbleBitmap structure in destination image. The destination image does not need to be configured in any way before the call is made.

See also: PixelFormatEnums

Parameters:

• format The output pixel format.
• destImage Destination image.

Implements SpinnakerNET::IManagedImage::ConvertToWriteAbleBitmap

---

function ConvertToWriteAbleBitmap [2/2]

virtual void SpinnakerNET::ManagedImage::ConvertToWriteAbleBitmap (
    SpinnakerNET::PixelFormatEnums format,
    IManagedImage ^ destImage,
    SpinnakerNET::ColorProcessingAlgorithm algorithm
) 

Converts the current image buffer to the specified output pixel format using specified color processing algorithm, stores the result and populates the BitmapSource structure in destination image. The destination image does not need to be configured in any way before the call is made.

See also: PixelFormatEnums

See also: ColorProcessingAlgorithm

Parameters:

• format The output pixel format.
• destImage Destination image.
• algorithm Color processing algorithm for producing the destImage.

Implements SpinnakerNET::IManagedImage::ConvertToWriteAbleBitmap

---

function DeepCopy

virtual void SpinnakerNET::ManagedImage::DeepCopy (
    IManagedImage ^ srcImage
) 

Performs a deep copy of the ManagedImage. After this operation, the contents and member variables of the ManagedImage and the copy are the same but the two ManagedImages do not share a buffer. The ManagedImage's current buffer is not released.

Parameters:

• srcImage The ManagedImage to copy the data from.

Implements SpinnakerNET::IManagedImage::DeepCopy

---

function GetBufferSize

virtual unsigned  int SpinnakerNET::ManagedImage::GetBufferSize () 

Gets the size of the buffer associated with the image in bytes.

Returns:

The size of the buffer, in bytes.

Implements SpinnakerNET::IManagedImage::GetBufferSize

---

function ManagedImage [1/6]

SpinnakerNET::ManagedImage::ManagedImage () 

Default constructor to create a managed image object.

---

function ManagedImage [2/6]

SpinnakerNET::ManagedImage::ManagedImage (
    IManagedImage ^ srcImage
) 

Copy constructor that creates a deep copy of the source ManagedImage.

Parameters:

• srcImage The ManagedImage to copy the data from.

---

function ManagedImage [3/6]

SpinnakerNET::ManagedImage::ManagedImage (
    System::String ^ fileName
) 

Creates an image object from file.

Parameters:

• filename Name of the file to load an image object from.

See also: Save()

---

function ManagedImage [4/6]

SpinnakerNET::ManagedImage::ManagedImage (
    unsigned  int width,
    unsigned  int height,
    unsigned  int offsetX,
    unsigned  int offsetY,
    SpinnakerNET::PixelFormatEnums pixelFormat,
    void * pData
) 

Default constructor to create a managed image object using some additional parameters.

See also: SpinnakerNET::PixelFormatEnums

Parameters:

• width The image width in pixels
• height The image height in pixels
• offsetX The image x offset
• offsetY The image y offset
• pixelFormat The image pixel format
• pData The image data array

---

function ManagedImage [5/6]

SpinnakerNET::ManagedImage::ManagedImage (
    unsigned  int width,
    unsigned  int height,
    unsigned  int offsetX,
    unsigned  int offsetY,
    SpinnakerNET::PixelFormatEnums pixelFormat,
    void * pData,
    SpinnakerNET::TLPayloadType dataPayloadType,
    size_t dataSize
) 

Create an image object with the specified parameters. This function is used to create an image from existing image data with a specific payload type, such as a compressed image.

Parameters:

• width The image width in pixels
• height The image height in pixels
• offsetX The image X offset
• offsetY The image Y offset
• pixelFormat The image pixel format
• pData The compressed image data
• dataPayloadType The payload type of the data. This value can be retrieved from an existing image by using the TLPayloadType() function call.
• dataSize The size of the provided data in bytes

See also: TLPayloadType()

---

function Release

virtual void SpinnakerNET::ManagedImage::Release () 

Implements SpinnakerNET::IManagedImage::Release

---

function ResetImage [1/2]

virtual void SpinnakerNET::ManagedImage::ResetImage (
    unsigned  int width,
    unsigned  int height,
    unsigned  int offsetX,
    unsigned  int offsetY,
    SpinnakerNET::PixelFormatEnums pixelFormat
) 

Sets new dimensions of the image object and allocates memory.

Parameters:

• width The width of image in pixels to set.
• height The height of image in pixels to set.
• offsetX The x offset in pixels to set.
• offsetY The y offset in pixels to set.
• pixelFormat Pixel format to set.

Implements SpinnakerNET::IManagedImage::ResetImage

---

function ResetImage [2/2]

virtual void SpinnakerNET::ManagedImage::ResetImage (
    unsigned  int width,
    unsigned  int height,
    unsigned  int offsetX,
    unsigned  int offsetY,
    SpinnakerNET::PixelFormatEnums pixelFormat,
    void * pData
) 

Sets new dimensions of the image object.

Parameters:

• width The width of image in pixels to set.
• height The height of image in pixels to set.
• offsetX The x offset in pixels to set.
• offsetY The y offset in pixels to set.
• pixelFormat Pixel format to set.
• pData Pointer to the image buffer.

Implements SpinnakerNET::IManagedImage::ResetImage

---

function Save [1/9]

virtual void SpinnakerNET::ManagedImage::Save (
    System::String^ fileName
) 

Saves the image to the specified file name.

Parameters:

• fileName Filename to save image with.

---

function Save [2/9]

virtual void SpinnakerNET::ManagedImage::Save (
    System::String^ fileName,
    ImageFileFormat format
) 

Saves the image to the specified file name with the file format specified.

Parameters:

• fileName Filename to save image with.
• format File format to save in.

---

function Save [3/9]

virtual void SpinnakerNET::ManagedImage::Save (
    System::String^ fileName,
    PngOption ^ option
) 

Saves the image to the specified file name with the options specified.

Parameters:

• fileName Filename to save image with.
• option Options to use for saving PNG images.

---

function Save [4/9]

virtual void SpinnakerNET::ManagedImage::Save (
    System::String^ fileName,
    PpmOption ^ option
) 

Saves the image to the specified file name with the options specified.

Parameters:

• fileName Filename to save image with.
• option Options to use for saving PPM images.

---

function Save [5/9]

virtual void SpinnakerNET::ManagedImage::Save (
    System::String^ fileName,
    PgmOption ^ option
) 

Saves the image to the specified file name with the options specified.

Parameters:

• fileName Filename to save image with.
• option Options to use for saving PGM images.

---

function Save [6/9]

virtual void SpinnakerNET::ManagedImage::Save (
    System::String^ fileName,
    TiffOption ^ option
) 

Saves the image to the specified file name with the options specified.

Parameters:

• fileName Filename to save image with.
• option Options to use for saving TIFF images.

---

function Save [7/9]

virtual void SpinnakerNET::ManagedImage::Save (
    System::String^ fileName,
    JpegOption ^ option
) 

Saves the image to the specified file name with the options specified.

Parameters:

• fileName Filename to save image with.
• option Options to use for saving JPEG images.

---

function Save [8/9]

virtual void SpinnakerNET::ManagedImage::Save (
    System::String^ fileName,
    Jpg2Option ^ option
) 

Saves the image to the specified file name with the options specified.

Parameters:

• fileName Filename to save image with.
• option Options to use for saving JPG2 images.

---

function Save [9/9]

virtual void SpinnakerNET::ManagedImage::Save (
    System::String^ fileName,
    BmpOption ^ option
) 

Saves the image to the specified file name with the options specified.

Parameters:

• pFilename Filename to save image with.
• pOption Options to use while saving image.

---

function operator=

ManagedImage SpinnakerNET::ManagedImage::operator= (
    const  ManagedImage % other
) 

---

function ~ManagedImage

virtual SpinnakerNET::ManagedImage::~ManagedImage () 

Virtual destructor.

---

---

The documentation for this class was generated from the following file C:/workspace/src/SpinnakerNET/ManagedImage.h