MyCaffe  1.11.8.27
Deep learning software for Windows C# programmers.
MyCaffe.basecode.descriptors.SourceDescriptor Class Reference

The SourceDescriptor class contains all information describing a data source. More...

Inheritance diagram for MyCaffe.basecode.descriptors.SourceDescriptor:
MyCaffe.basecode.descriptors.BaseDescriptor

Public Member Functions

 SourceDescriptor (int nID, string strName, int nWd, int nHt, int nCh, bool bIsRealData, bool bSaveImagesToFile, int nCopyOfSourceId=0, string strOwner=null, int nCount=0, List< LabelDescriptor > rgLabels=null, string strLabelCounts=null)
 The SourceDescriptor constructor. More...
 
 SourceDescriptor (string strName, bool bSaveImagesToFile)
 The SourceDescriptor constructor. More...
 
 SourceDescriptor (SourceDescriptor s)
 The SourceDescriptor constructor. More...
 
void Copy (SourceDescriptor sd)
 Copy another SourceDesciptor into this one. More...
 
void Resize (int nChannels, int nHeight, int nWidth)
 Resize the testing and training data sources. More...
 
void SetInactiveImageCount (int nCount)
 Set the number of inactive images within this data source. More...
 
override string ToString ()
 Return a string representation of thet SourceDescriptor. More...
 
- Public Member Functions inherited from MyCaffe.basecode.descriptors.BaseDescriptor
 BaseDescriptor (int nID, string strName, string strOwner)
 The BaseDescriptor constructor. More...
 
 BaseDescriptor (BaseDescriptor b)
 The BaseDescriptor constructor. More...
 
void Copy (BaseDescriptor b)
 Copy another BaseDescriptor into this one. More...
 

Properties

bool SaveImagesToFile [get]
 Gets whether or not the images are saved to the file system (true), or directly to the database (false). More...
 
int CopyOfSourceID [getset]
 Get/set the Source ID from which this source was copied. If this Source is an original, this property should be 0. More...
 
List< LabelDescriptorLabels [getset]
 Get/set the list of LabelDescriptors that describe the labels used by the data items. More...
 
int ImageHeight [get]
 Returns the height of each data item in the data source. More...
 
int ImageWidth [get]
 Returns the width of each data item in the data source. More...
 
int ImageChannels [get]
 Returns the image colors - 1 channel = black/white, 3 channels = RGB color. More...
 
bool IsRealData [get]
 Returns whether or not the each data point represents a real or integer number. Integer numbers are used for black/white and color images where each data point falls within the range [0 - 255]. More...
 
int ImageCount [get]
 Returns the number of images within this data source. More...
 
int InactiveImageCount [get]
 Returns the number of inactive images within this data source. More...
 
string LabelCountsAsText [getset]
 Get/set a string that lists the number of images for each label associated with this data source. More...
 
ParameterDescriptorCollection Parameters [getset]
 Get/set the source parameters (if any). More...
 
- Properties inherited from MyCaffe.basecode.descriptors.BaseDescriptor
int ID [getset]
 Get/set the database ID of the item. More...
 
string Name [getset]
 Get/set the name of the item. More...
 
string Owner [getset]
 Get/set the owner of the item. More...
 

Detailed Description

The SourceDescriptor class contains all information describing a data source.

Definition at line 15 of file SourceDescriptor.cs.

Constructor & Destructor Documentation

◆ SourceDescriptor() [1/3]

MyCaffe.basecode.descriptors.SourceDescriptor.SourceDescriptor ( int  nID,
string  strName,
int  nWd,
int  nHt,
int  nCh,
bool  bIsRealData,
bool  bSaveImagesToFile,
int  nCopyOfSourceId = 0,
string  strOwner = null,
int  nCount = 0,
List< LabelDescriptor rgLabels = null,
string  strLabelCounts = null 
)

The SourceDescriptor constructor.

Parameters
nIDSpecifies the database ID of the item.
strNameSpecifies the name of the item.
nWdSpecifies the width of each data item.
nHtSpecifies the height of each data item.
nChSpecifies the channels of each data item.
bIsRealDataSpecifies whether or not the data items contain real data or byte data.
bSaveImagesToFileSpecifies whether the images are saved to the file system (true), or directly to the database (false).
nCopyOfSourceIdSpecifies whether or not this is a copy of another source and if so, this is the ID of the original source.
strOwnerOptionally, specifies the identifier of the item's owner.
nCountOptionallty, specifies the number of items in the data source.
rgLabelsOptionally, specifies a list of LabelDescriptors that describe the labels used by the data items.
strLabelCountsOptionally, specifies a string containing the label counts.

Definition at line 44 of file SourceDescriptor.cs.

◆ SourceDescriptor() [2/3]

MyCaffe.basecode.descriptors.SourceDescriptor.SourceDescriptor ( string  strName,
bool  bSaveImagesToFile 
)

The SourceDescriptor constructor.

Parameters
strNameSpecifies the name of the item.
bSaveImagesToFileSpecifies whether the images are saved to the file system (true), or directly to the database (false).

Definition at line 63 of file SourceDescriptor.cs.

◆ SourceDescriptor() [3/3]

MyCaffe.basecode.descriptors.SourceDescriptor.SourceDescriptor ( SourceDescriptor  s)

The SourceDescriptor constructor.

Parameters
sSpecifies another SourceDescriptor used to create this one.

Definition at line 72 of file SourceDescriptor.cs.

Member Function Documentation

◆ Copy()

void MyCaffe.basecode.descriptors.SourceDescriptor.Copy ( SourceDescriptor  sd)

Copy another SourceDesciptor into this one.

Parameters
sdSpecifies the SourceDesciptor to copy.

Definition at line 87 of file SourceDescriptor.cs.

◆ Resize()

void MyCaffe.basecode.descriptors.SourceDescriptor.Resize ( int  nChannels,
int  nHeight,
int  nWidth 
)

Resize the testing and training data sources.

Parameters
nChannelsSpecifies the new channel size.
nHeightSpecifies the new height size.
nWidthSpecifies the new width size.

Definition at line 121 of file SourceDescriptor.cs.

◆ SetInactiveImageCount()

void MyCaffe.basecode.descriptors.SourceDescriptor.SetInactiveImageCount ( int  nCount)

Set the number of inactive images within this data source.

Parameters
nCount

Definition at line 216 of file SourceDescriptor.cs.

◆ ToString()

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

Return a string representation of thet SourceDescriptor.

Returns
The string representation is returned.

Definition at line 236 of file SourceDescriptor.cs.

Property Documentation

◆ CopyOfSourceID

int MyCaffe.basecode.descriptors.SourceDescriptor.CopyOfSourceID
getset

Get/set the Source ID from which this source was copied. If this Source is an original, this property should be 0.

Definition at line 142 of file SourceDescriptor.cs.

◆ ImageChannels

int MyCaffe.basecode.descriptors.SourceDescriptor.ImageChannels
get

Returns the image colors - 1 channel = black/white, 3 channels = RGB color.

Definition at line 180 of file SourceDescriptor.cs.

◆ ImageCount

int MyCaffe.basecode.descriptors.SourceDescriptor.ImageCount
get

Returns the number of images within this data source.

Definition at line 198 of file SourceDescriptor.cs.

◆ ImageHeight

int MyCaffe.basecode.descriptors.SourceDescriptor.ImageHeight
get

Returns the height of each data item in the data source.

Definition at line 162 of file SourceDescriptor.cs.

◆ ImageWidth

int MyCaffe.basecode.descriptors.SourceDescriptor.ImageWidth
get

Returns the width of each data item in the data source.

Definition at line 171 of file SourceDescriptor.cs.

◆ InactiveImageCount

int MyCaffe.basecode.descriptors.SourceDescriptor.InactiveImageCount
get

Returns the number of inactive images within this data source.

Definition at line 207 of file SourceDescriptor.cs.

◆ IsRealData

bool MyCaffe.basecode.descriptors.SourceDescriptor.IsRealData
get

Returns whether or not the each data point represents a real or integer number. Integer numbers are used for black/white and color images where each data point falls within the range [0 - 255].

Definition at line 189 of file SourceDescriptor.cs.

◆ LabelCountsAsText

string MyCaffe.basecode.descriptors.SourceDescriptor.LabelCountsAsText
getset

Get/set a string that lists the number of images for each label associated with this data source.

Definition at line 226 of file SourceDescriptor.cs.

◆ Labels

List<LabelDescriptor> MyCaffe.basecode.descriptors.SourceDescriptor.Labels
getset

Get/set the list of LabelDescriptors that describe the labels used by the data items.

Definition at line 152 of file SourceDescriptor.cs.

◆ Parameters

ParameterDescriptorCollection MyCaffe.basecode.descriptors.SourceDescriptor.Parameters
getset

Get/set the source parameters (if any).

Definition at line 245 of file SourceDescriptor.cs.

◆ SaveImagesToFile

bool MyCaffe.basecode.descriptors.SourceDescriptor.SaveImagesToFile
get

Gets whether or not the images are saved to the file system (true), or directly to the database (false).

Definition at line 132 of file SourceDescriptor.cs.


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