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

Inheritance diagram for MyCaffe.basecode.descriptors.SourceDescriptor:

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, byte[] rgbTemporal=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< LabelDescriptor >	Labels `[getset]`
	Get/set the list of LabelDescriptors that describe the labels used by the data items. More...

int	Height `[get]`
	Returns the height of each data item in the data source. More...

int	Width `[get]`
	Returns the width of each data item in the data source. More...

int	Channels `[get]`
	Returns the item 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...

TemporalDescriptor	TemporalDescriptor `[getset]`
	Get/set the temporal descriptor (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`,
		byte[]	rgbTemporal = `null`
	)

The SourceDescriptor constructor.

Parameters

nID	Specifies the database ID of the item.
strName	Specifies the name of the item.
nWd	Specifies the width of each data item.
nHt	Specifies the height of each data item.
nCh	Specifies the channels of each data item.
bIsRealData	Specifies whether or not the data items contain real data or byte data.
bSaveImagesToFile	Specifies whether the images are saved to the file system (true), or directly to the database (false).
nCopyOfSourceId	Specifies whether or not this is a copy of another source and if so, this is the ID of the original source.
strOwner	Optionally, specifies the identifier of the item's owner.
nCount	Optionallty, specifies the number of items in the data source.
rgLabels	Optionally, specifies a list of LabelDescriptors that describe the labels used by the data items.
strLabelCounts	Optionally, specifies a string containing the label counts.
rgbTemporal	Optionally, specifies the temporal data.

Definition at line 46 of file SourceDescriptor.cs.

◆ SourceDescriptor() [2/3]

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

The SourceDescriptor constructor.

Parameters

strName	Specifies the name of the item.
bSaveImagesToFile	Specifies whether the images are saved to the file system (true), or directly to the database (false).

Definition at line 66 of file SourceDescriptor.cs.

◆ SourceDescriptor() [3/3]

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

The SourceDescriptor constructor.

Parameters

s	Specifies another SourceDescriptor used to create this one.

Definition at line 75 of file SourceDescriptor.cs.

Member Function Documentation

◆ Copy()

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

Copy another SourceDesciptor into this one.

Parameters

sd	Specifies the SourceDesciptor to copy.

Definition at line 94 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

nChannels	Specifies the new channel size.
nHeight	Specifies the new height size.
nWidth	Specifies the new width size.

Definition at line 131 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 226 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 246 of file SourceDescriptor.cs.

Property Documentation

◆ Channels

int MyCaffe.basecode.descriptors.SourceDescriptor.Channels

get

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

Definition at line 190 of file SourceDescriptor.cs.

◆ 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 152 of file SourceDescriptor.cs.

◆ Height

int MyCaffe.basecode.descriptors.SourceDescriptor.Height

get

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

Definition at line 172 of file SourceDescriptor.cs.

◆ ImageCount

int MyCaffe.basecode.descriptors.SourceDescriptor.ImageCount

get

Returns the number of images within this data source.

Definition at line 208 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 217 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 199 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 236 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 162 of file SourceDescriptor.cs.

◆ Parameters

ParameterDescriptorCollection MyCaffe.basecode.descriptors.SourceDescriptor.Parameters

getset

Get/set the source parameters (if any).

Definition at line 255 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 142 of file SourceDescriptor.cs.

◆ TemporalDescriptor

TemporalDescriptor MyCaffe.basecode.descriptors.SourceDescriptor.TemporalDescriptor

getset

Get/set the temporal descriptor (if any).

Definition at line 265 of file SourceDescriptor.cs.

◆ Width

int MyCaffe.basecode.descriptors.SourceDescriptor.Width

get

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

Definition at line 181 of file SourceDescriptor.cs.

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

C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.basecode/descriptors/SourceDescriptor.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SourceDescriptor() [1/3]

◆ SourceDescriptor() [2/3]

◆ SourceDescriptor() [3/3]

Member Function Documentation

◆ Copy()

◆ Resize()

◆ SetInactiveImageCount()

◆ ToString()

Property Documentation

◆ Channels

◆ CopyOfSourceID

◆ Height

◆ ImageCount

◆ InactiveImageCount

◆ IsRealData

◆ LabelCountsAsText

◆ Labels

◆ Parameters

◆ SaveImagesToFile

◆ TemporalDescriptor

◆ Width