PatchOptions Class Reference

Class for specifying spatio-temporal patches (cubes). More...

#include <PatchOptions.hpp>

List of all members.

Public Types

enum  norm_type { NORM_NONE, NORM_ZM, NORM_ZMUV }
 

Normalization mode for each patch.

More...

Public Member Functions

 PatchOptions (Point3i win, Point3i step, norm_type normopt, double minvar=0, int minvarf=0)
 create an instance of PatchOptions.
 PatchOptions (int winxy, int winz, int stepxy, int stepz, norm_type normopt, double minvar=0, int minvarf=0)
 create an instance of PatchOptions (square patch and square step).
void dump (ostream &output) const
 debugging: dump to stream.
void dump_matlab (ostream &output) const
 debugging: dump to a matlab-readable stream (patopt struct).

Static Public Member Functions

static const char * norm_type_to_string (norm_type)
 debugging: convert norm_type to a string.

Public Attributes

Point3i win
 patch size (x, y, z).
Point3i step
 step size between patches (x, y, z).
norm_type normopt
 normalization method.
double minvar
 minimum variance.
int minvarf
 frames to skip in checking variance.

Private Member Functions

void checkValues ()
 check for illegal values in PatchOptions.

Friends

ostream & operator<< (ostream &output, const PatchOptions &po)
 debugging: dump to a stream.

Detailed Description

Class for specifying spatio-temporal patches (cubes).

See also:
PatchExtractor, PatchBatchExtractor

Definition at line 20 of file PatchOptions.hpp.


Member Enumeration Documentation

Normalization mode for each patch.

Enumerator:
NORM_NONE 

no normalization.

NORM_ZM 

each pixel is zero-mean in time.

NORM_ZMUV 

each pixel is zero-mean in time, and all pixels have unit-variance.

Definition at line 25 of file PatchOptions.hpp.


Constructor & Destructor Documentation

PatchOptions::PatchOptions ( int  winxy,
int  winz,
int  stepxy,
int  stepz,
norm_type  normopt,
double  minvar = 0,
int  minvarf = 0 
)

create an instance of PatchOptions (square patch and square step).

Parameters:
winxy x & y patch size
winz z patch size
stepxy x & y step size
stepz z step size
normopt the normalization mode

Definition at line 31 of file PatchOptions.cpp.

Here is the call graph for this function:


Member Function Documentation

void PatchOptions::checkValues (  )  [private]

check for illegal values in PatchOptions.

Definition at line 44 of file PatchOptions.cpp.

Here is the caller graph for this function:

void PatchOptions::dump ( ostream &  output  )  const

debugging: dump to stream.

Definition at line 65 of file PatchOptions.cpp.

Here is the call graph for this function:

void PatchOptions::dump_matlab ( ostream &  output  )  const

debugging: dump to a matlab-readable stream (patopt struct).

Definition at line 72 of file PatchOptions.cpp.

const char * PatchOptions::norm_type_to_string ( norm_type  normopt  )  [static]

debugging: convert norm_type to a string.

Definition at line 54 of file PatchOptions.cpp.

Here is the caller graph for this function:


Friends And Related Function Documentation

ostream& operator<< ( ostream &  output,
const PatchOptions &  po 
) [friend]

debugging: dump to a stream.

See also:
dump

Member Data Documentation

minimum variance.

Definition at line 35 of file PatchOptions.hpp.

frames to skip in checking variance.

Definition at line 36 of file PatchOptions.hpp.

normalization method.

Definition at line 34 of file PatchOptions.hpp.

step size between patches (x, y, z).

Definition at line 33 of file PatchOptions.hpp.

patch size (x, y, z).

Definition at line 32 of file PatchOptions.hpp.


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

Generated on 18 Dec 2014 for libdt-OpenCV by  doxygen 1.6.1