MyCaffe  1.12.2.41
Deep learning software for Windows C# programmers.
MyCaffe.basecode.descriptors.ImageDescriptor Class Reference

The ImageDescriptor class describes a single image in the database. More...

Public Member Functions

 ImageDescriptor (int nID, int nH, int nW, int nC, bool bEncoded, int nSrcID, int nIdx, int nActiveLabel, bool bActive, string strDesc, DateTime dt)
 The ImageDescriptor constructor. More...
 
 ImageDescriptor (ImageDescriptor id)
 The ImageDescriptor constructor. More...
 
override string ToString ()
 Creates the string representation of the descriptor. More...
 

Properties

int ID [get]
 Returns the ID of the image. More...
 
int Height [get]
 Returns the height of the image. More...
 
int Width [get]
 Returns the width of the image. More...
 
int Channels [get]
 Returns the channels of the image (i.e. 3 = RGB, 1 = B/W) More...
 
bool Encoded [get]
 Returns whether or not the image is encoded. More...
 
int SourceID [get]
 Returns the ID of the source associated with the image. More...
 
int Index [get]
 Returns the index of the image. More...
 
int ActiveLabel [get]
 Returns the active label of the image. More...
 
bool Active [get]
 Returns whether or not the image is active. More...
 
string Description [get]
 Returns the description of the image. More...
 
DateTime TimeStamp [get]
 Specifies the time-stamp of the image (if any). More...
 

Detailed Description

The ImageDescriptor class describes a single image in the database.

Definition at line 13 of file ImageDescriptor.cs.

Constructor & Destructor Documentation

◆ ImageDescriptor() [1/2]

MyCaffe.basecode.descriptors.ImageDescriptor.ImageDescriptor ( int  nID,
int  nH,
int  nW,
int  nC,
bool  bEncoded,
int  nSrcID,
int  nIdx,
int  nActiveLabel,
bool  bActive,
string  strDesc,
DateTime  dt 
)

The ImageDescriptor constructor.

Parameters
nIDSpecifies the image ID.
nHSpecifies the image heights.
nWSpecifies the image width.
nCSpecifies teh image channels.
bEncodedSpecifies whether or not the image has encoded data.
nSrcIDSpecifies the ID of the source holding the image.
nIdxSpecifies the image index.
nActiveLabelSpecifies the active label of the image.
bActiveSpecifies whether or not the image is active.
strDescSpecifies the description of the image.
dtSpecifies the time-stamp of the image.

Definition at line 41 of file ImageDescriptor.cs.

◆ ImageDescriptor() [2/2]

MyCaffe.basecode.descriptors.ImageDescriptor.ImageDescriptor ( ImageDescriptor  id)

The ImageDescriptor constructor.

Parameters
idSpecifies another ImageDescriptor to copy.

Definition at line 60 of file ImageDescriptor.cs.

Member Function Documentation

◆ ToString()

override string MyCaffe.basecode.descriptors.ImageDescriptor.ToString ( )

Creates the string representation of the descriptor.

Returns
The string representation of the descriptor is returned.

Definition at line 157 of file ImageDescriptor.cs.

Property Documentation

◆ Active

bool MyCaffe.basecode.descriptors.ImageDescriptor.Active
get

Returns whether or not the image is active.

Definition at line 132 of file ImageDescriptor.cs.

◆ ActiveLabel

int MyCaffe.basecode.descriptors.ImageDescriptor.ActiveLabel
get

Returns the active label of the image.

Definition at line 124 of file ImageDescriptor.cs.

◆ Channels

int MyCaffe.basecode.descriptors.ImageDescriptor.Channels
get

Returns the channels of the image (i.e. 3 = RGB, 1 = B/W)

Definition at line 92 of file ImageDescriptor.cs.

◆ Description

string MyCaffe.basecode.descriptors.ImageDescriptor.Description
get

Returns the description of the image.

Definition at line 140 of file ImageDescriptor.cs.

◆ Encoded

bool MyCaffe.basecode.descriptors.ImageDescriptor.Encoded
get

Returns whether or not the image is encoded.

Definition at line 100 of file ImageDescriptor.cs.

◆ Height

int MyCaffe.basecode.descriptors.ImageDescriptor.Height
get

Returns the height of the image.

Definition at line 76 of file ImageDescriptor.cs.

◆ ID

int MyCaffe.basecode.descriptors.ImageDescriptor.ID
get

Returns the ID of the image.

Definition at line 68 of file ImageDescriptor.cs.

◆ Index

int MyCaffe.basecode.descriptors.ImageDescriptor.Index
get

Returns the index of the image.

Definition at line 116 of file ImageDescriptor.cs.

◆ SourceID

int MyCaffe.basecode.descriptors.ImageDescriptor.SourceID
get

Returns the ID of the source associated with the image.

Definition at line 108 of file ImageDescriptor.cs.

◆ TimeStamp

DateTime MyCaffe.basecode.descriptors.ImageDescriptor.TimeStamp
get

Specifies the time-stamp of the image (if any).

Definition at line 148 of file ImageDescriptor.cs.

◆ Width

int MyCaffe.basecode.descriptors.ImageDescriptor.Width
get

Returns the width of the image.

Definition at line 84 of file ImageDescriptor.cs.


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