vidl2_memory_chunk_frame Class Reference

#include <vidl2_frame.h>

Inheritance diagram for vidl2_memory_chunk_frame:

[legend]List of all members.

---

Detailed Description

A frame buffer that wraps a vil_memory_chunk.

This is useful when the frame actually came from a vil_image

Definition at line 118 of file vidl2_frame.h.

Public Member Functions
	vidl2_memory_chunk_frame ()
	Constructor.
	vidl2_memory_chunk_frame (unsigned ni, unsigned nj, vidl2_pixel_format fmt, const vil_memory_chunk_sptr &memory)
	Constructor - from a vil_memory_chunk_sptr.
	vidl2_memory_chunk_frame (const vil_image_view_base &image, vidl2_pixel_format fmt=VIDL2_PIXEL_FORMAT_UNKNOWN)
	Constructor - from a vil_image_view.
const vil_memory_chunk_sptr &	memory_chunk () const
	Return the memory chunk.
virtual	~vidl2_memory_chunk_frame ()
	Destructor.
virtual void	invalidate ()
	Make the buffer invalid (data()==0 and size()==0).
virtual void *	data ()
	Return a pointer to the first element of data.
virtual const void *	data () const
virtual unsigned long	size () const
	The size of the buffer in bytes.
unsigned	ni () const
	Width.
unsigned	nj () const
	Height.
vidl2_pixel_format	pixel_format () const
	Return the pixel format.
void	ref ()
	Increment reference count.
void	unref ()
	Decrement reference count.
int	ref_count () const
	Number of objects referring to this data.
Protected Attributes
unsigned	ni_
	frame width.
unsigned	nj_
	frame height.
vidl2_pixel_format	format_
	frame pixel format.
Private Attributes
vil_memory_chunk_sptr	memory_

---

Constructor & Destructor Documentation

vidl2_memory_chunk_frame::vidl2_memory_chunk_frame (   )  [inline]

Constructor. Definition at line 122 of file vidl2_frame.h.

vidl2_memory_chunk_frame::vidl2_memory_chunk_frame (  unsigned  ni, unsigned  nj, vidl2_pixel_format  fmt, const vil_memory_chunk_sptr &  memory )  [inline]

Constructor - from a vil_memory_chunk_sptr. Definition at line 125 of file vidl2_frame.h.

vidl2_memory_chunk_frame::vidl2_memory_chunk_frame (  const vil_image_view_base &  image, vidl2_pixel_format  fmt = VIDL2_PIXEL_FORMAT_UNKNOWN )

Constructor - from a vil_image_view. return an invalid frame if the image format can not be wrapped Parameters: fmt  if not UNKNOWN, requires this pixel or fails Definition at line 34 of file vidl2_frame.cxx.

virtual vidl2_memory_chunk_frame::~vidl2_memory_chunk_frame (   )  [inline, virtual]

Destructor. Definition at line 140 of file vidl2_frame.h.

---

Member Function Documentation

virtual const void* vidl2_memory_chunk_frame::data (   )  const [inline, virtual]

Implements vidl2_frame. Definition at line 147 of file vidl2_frame.h.

virtual void* vidl2_memory_chunk_frame::data (   )  [inline, virtual]

Return a pointer to the first element of data. Implements vidl2_frame. Definition at line 146 of file vidl2_frame.h.

virtual void vidl2_memory_chunk_frame::invalidate (   )  [inline, virtual]

Make the buffer invalid (data()==0 and size()==0). Reimplemented from vidl2_frame. Definition at line 143 of file vidl2_frame.h.

const vil_memory_chunk_sptr& vidl2_memory_chunk_frame::memory_chunk (   )  const [inline]

Return the memory chunk. used in recreating a vil_image_view Definition at line 137 of file vidl2_frame.h.

unsigned vidl2_frame::ni (   )  const [inline, inherited]

Width. Definition at line 44 of file vidl2_frame.h.

unsigned vidl2_frame::nj (   )  const [inline, inherited]

Height. Definition at line 47 of file vidl2_frame.h.

vidl2_pixel_format vidl2_frame::pixel_format (   )  const [inline, inherited]

Return the pixel format. Definition at line 50 of file vidl2_frame.h.

void vidl2_frame::ref (   )  [inline, inherited]

Increment reference count. Definition at line 73 of file vidl2_frame.h.

int vidl2_frame::ref_count (   )  const [inline, inherited]

Number of objects referring to this data. Definition at line 79 of file vidl2_frame.h.

virtual unsigned long vidl2_memory_chunk_frame::size (   )  const [inline, virtual]

The size of the buffer in bytes. Implements vidl2_frame. Definition at line 150 of file vidl2_frame.h.

void vidl2_frame::unref (   )  [inherited]

Decrement reference count. Definition at line 19 of file vidl2_frame.cxx.

---

Member Data Documentation

vidl2_pixel_format vidl2_frame::format_ [protected, inherited]

frame pixel format. Definition at line 66 of file vidl2_frame.h.

vil_memory_chunk_sptr vidl2_memory_chunk_frame::memory_ [private]

Definition at line 153 of file vidl2_frame.h.

unsigned vidl2_frame::ni_ [protected, inherited]

frame width. Definition at line 62 of file vidl2_frame.h.

unsigned vidl2_frame::nj_ [protected, inherited]

frame height. Definition at line 64 of file vidl2_frame.h.

---

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

• contrib/brl/bbas/vidl2/vidl2_frame.h
• contrib/brl/bbas/vidl2/vidl2_frame.cxx

---