vidl_vil1_clip Class Reference

#include <vidl_vil1_clip.h>

Inheritance diagram for vidl_vil1_clip:

List of all members.

---

Detailed Description

Sequence of frames, element of a movie.

A clip is a set of frames, it is part of a Movie. It has the notion of starting frame, ending frame and increment, so that when we iterate through the sequence, it will iterate only through the frames of interest.

See also vidl_vil1_frame and vidl_vil1_movie.

Definition at line 32 of file vidl_vil1_clip.h.

Public Member Functions
	vidl_vil1_clip (vidl_vil1_codec_sptr codec, int start=0, int end=0, int increment=1)
	Constructor. Takes a vidl_vil1_codec, start, end and increment frames are optional.
	vidl_vil1_clip (vcl_list< vil1_image > &images, int start=0, int end=0, int increment=1)
	Constructor. Create a clip from a list of images. Start, end and increment frames are optional.
	vidl_vil1_clip (vcl_vector< vil1_image > &images, int start=0, int end=0, int increment=1)
	Constructor. Create a clip from a vector of images. Start, end and increment frames are optional.
	vidl_vil1_clip (vidl_vil1_clip const &x)
	~vidl_vil1_clip ()
vidl_vil1_frame_sptr	get_frame (int n)
	Get the frame numbered n inside the range defined by startframe, endframe and increment.
int	length () const
	Return the number of frames.
int	width () const
	Return the horizontal size of the frames in the clip.
int	height () const
	Return the vertical size of the frames in the clip.
vidl_vil1_codec_sptr	get_codec ()
	Return the codec.
void	ref ()
void	unref ()
int	get_references () const
bool	is_referenced () const
Protected Member Functions
void	init (int start, int end, int increment)
	Initialization of the clip. Protected.
Protected Attributes
vcl_vector< vidl_vil1_frame_sptr >	frames_
	Where are the frames stored.
int	startframe_
	The clip begins at startframe_.
int	endframe_
	The clip ends at startframe_.
int	increment_
	The clip uses 1 frame every "increment_".
double	frame_rate_
	1 frame every ?? secs
vidl_vil1_codec_sptr	coder_
	video codec used for storage

---

Constructor & Destructor Documentation

vidl_vil1_clip::vidl_vil1_clip	(	vidl_vil1_codec_sptr	codec,
		int	start = 0,
		int	end = 0,
		int	increment = 1
	)

Constructor. Takes a vidl_vil1_codec, start, end and increment frames are optional.

Definition at line 20 of file vidl_vil1_clip.cxx.

vidl_vil1_clip::vidl_vil1_clip	(	vcl_list< vil1_image > &	images,
		int	start = 0,
		int	end = 0,
		int	increment = 1
	)

Constructor. Create a clip from a list of images. Start, end and increment frames are optional.

Definition at line 55 of file vidl_vil1_clip.cxx.

vidl_vil1_clip::vidl_vil1_clip	(	vcl_vector< vil1_image > &	images,
		int	start = 0,
		int	end = 0,
		int	increment = 1
	)

Constructor. Create a clip from a vector of images. Start, end and increment frames are optional.

Definition at line 33 of file vidl_vil1_clip.cxx.

vidl_vil1_clip::vidl_vil1_clip

(

vidl_vil1_clip const &

x

)

[inline]

Definition at line 54 of file vidl_vil1_clip.h.

vidl_vil1_clip::~vidl_vil1_clip

(

)

[inline]

Definition at line 60 of file vidl_vil1_clip.h.

---

Member Function Documentation

vidl_vil1_frame_sptr vidl_vil1_clip::get_frame

(

int

n

)

Get the frame numbered n inside the range defined by startframe, endframe and increment.

So, the returned frame is startframe_+n*increment_

Definition at line 111 of file vidl_vil1_clip.cxx.

int vidl_vil1_clip::length

(

)

const [inline]

Return the number of frames.

Definition at line 66 of file vidl_vil1_clip.h.

int vidl_vil1_clip::width

(

)

const

Return the horizontal size of the frames in the clip.

Definition at line 125 of file vidl_vil1_clip.cxx.

int vidl_vil1_clip::height

(

)

const

Return the vertical size of the frames in the clip.

Definition at line 131 of file vidl_vil1_clip.cxx.

vidl_vil1_codec_sptr vidl_vil1_clip::get_codec

(

)

[inline]

Return the codec.

Definition at line 73 of file vidl_vil1_clip.h.

void vidl_vil1_clip::init	(	int	start,
		int	end,
		int	increment
	)			[protected]

Initialization of the clip. Protected.

Definition at line 77 of file vidl_vil1_clip.cxx.

---

Member Data Documentation

vcl_vector<vidl_vil1_frame_sptr> vidl_vil1_clip::frames_ [protected]

Where are the frames stored.

Definition at line 79 of file vidl_vil1_clip.h.

int vidl_vil1_clip::startframe_ [protected]

The clip begins at startframe_.

Definition at line 80 of file vidl_vil1_clip.h.

int vidl_vil1_clip::endframe_ [protected]

The clip ends at startframe_.

Definition at line 81 of file vidl_vil1_clip.h.

int vidl_vil1_clip::increment_ [protected]

The clip uses 1 frame every "increment_".

Definition at line 82 of file vidl_vil1_clip.h.

double vidl_vil1_clip::frame_rate_ [protected]

1 frame every ?? secs

Definition at line 83 of file vidl_vil1_clip.h.

vidl_vil1_codec_sptr vidl_vil1_clip::coder_ [protected]

video codec used for storage

Definition at line 84 of file vidl_vil1_clip.h.

---

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

• core/vidl_vil1/vidl_vil1_clip.h
• core/vidl_vil1/vidl_vil1_clip.cxx

---