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

The LabelMapping class represents a single label mapping. More...

Public Member Functions

 LabelMapping (int nOriginalLabel, int nNewLabel, int? nConditionBoostEquals, int? nNewLabelConditionFalse)
 The LabelMapping constructor. More...
 
 LabelMapping ()
 The LabelMapping constructor. More...
 
LabelMapping Clone ()
 Return a copy of the LabelMapping. More...
 
override string ToString ()
 Return a string representation of the label mapping. More...
 

Static Public Member Functions

static LabelMapping Parse (string str)
 Parse a string into a new LabelMapping. More...
 

Properties

int OriginalLabel [getset]
 Get/set the original label. More...
 
int NewLabel [getset]
 Get/set the new label. More...
 
int? NewLabelConditionFalse [getset]
 Get/set the label to use if the boost condition fails. More...
 
int? ConditionBoostEquals [getset]
 Get/set the boost condition to test which if met, the new label is set, otherwise it is not. More...
 

Detailed Description

The LabelMapping class represents a single label mapping.

Definition at line 325 of file LabelMapping.cs.

Constructor & Destructor Documentation

◆ LabelMapping() [1/2]

MyCaffe.basecode.LabelMapping.LabelMapping ( int  nOriginalLabel,
int  nNewLabel,
int?  nConditionBoostEquals,
int?  nNewLabelConditionFalse 
)

The LabelMapping constructor.

Parameters
nOriginalLabelSpecifies the original label.
nNewLabelSpecifies the new label.
nConditionBoostEqualsSpecifies a conditional boost value.
nNewLabelConditionFalseSpecifies the label to use if the conditional fails.

Definition at line 340 of file LabelMapping.cs.

◆ LabelMapping() [2/2]

MyCaffe.basecode.LabelMapping.LabelMapping ( )

The LabelMapping constructor.

Definition at line 351 of file LabelMapping.cs.

Member Function Documentation

◆ Clone()

LabelMapping MyCaffe.basecode.LabelMapping.Clone ( )

Return a copy of the LabelMapping.

Returns
The copy is returned.

Definition at line 399 of file LabelMapping.cs.

◆ Parse()

static LabelMapping MyCaffe.basecode.LabelMapping.Parse ( string  str)
static

Parse a string into a new LabelMapping.

The expected format for the label mapping is: originalLabel->newLabel[?newLabelFalse,boostCondition]

Where the newLabelFalse and boostCondition are optional.
The basic logic of the label map is as follows:

If no boost condition exists, map the original label to the new label.

If a boost condition exists and is met, map the original label to the new label.

If a boost condition exists and is not met and the newLabelFalse exists, map the original label to the newLabelFalse.

Parameters
strSpecifies the string to parse.
Returns
The new LabelMapping is returned.

Definition at line 425 of file LabelMapping.cs.

◆ ToString()

override string MyCaffe.basecode.LabelMapping.ToString ( )

Return a string representation of the label mapping.

Returns
The string representatio is returned.

Definition at line 478 of file LabelMapping.cs.

Property Documentation

◆ ConditionBoostEquals

int? MyCaffe.basecode.LabelMapping.ConditionBoostEquals
getset

Get/set the boost condition to test which if met, the new label is set, otherwise it is not.

Definition at line 389 of file LabelMapping.cs.

◆ NewLabel

int MyCaffe.basecode.LabelMapping.NewLabel
getset

Get/set the new label.

Definition at line 369 of file LabelMapping.cs.

◆ NewLabelConditionFalse

int? MyCaffe.basecode.LabelMapping.NewLabelConditionFalse
getset

Get/set the label to use if the boost condition fails.

Definition at line 379 of file LabelMapping.cs.

◆ OriginalLabel

int MyCaffe.basecode.LabelMapping.OriginalLabel
getset

Get/set the original label.

Definition at line 359 of file LabelMapping.cs.


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