MyCaffe.trainers.GetDataArgs Class Reference

The GetDataArgs is passed to the OnGetData event to retrieve data. More...

Inheritance diagram for MyCaffe.trainers.GetDataArgs:

Public Member Functions
	GetDataArgs (Phase phase, int nIdx, Component mycaffe, Log log, CancelEvent evtCancel, bool bReset, int nAction=-1, bool bAllowUi=true, bool bGetLabel=false, bool bBatchMode=false, IxTrainerGetDataCallback iOnGetData=null)
	The constructor. More...

Properties
IxTrainerGetDataCallback	GetDataCallback [get]
	Returns the OnGetData Callback called just after rendering yet before displaying the gym image. More...
PropertySet	ExtraProperties [getset]
	Get/set extra properties. More...
Phase	ActivePhase [get]
	Returns the active phase under which to get the data. More...
ManualResetEvent	DataReady [get]
	Returns the data ready event that is set once the data has been retrieved. This field is only used when using the OnGetDataAsync event. More...
int	Index [getset]
	Returns the index of the thread asking for the gym. More...
bool	GetLabel [get]
	Returns whether or not to retrieve the label in addition to the data. More...
Log	OutputLog [get]
	Returns the output log for general output. More...
CancelEvent	CancelEvent [get]
	Returns the cancel event. More...
StateBase	State [getset]
	Specifies the state data of the observations. More...
int	Action [getset]
	Returns the action to run. If less than zero, this parameter is ignored. More...
Component	MyCaffe [get]
	Returns the MyCaffeControl used. More...
bool	Reset [getset]
	Returns whether or not to reset the observation environment or not. More...

Detailed Description

The GetDataArgs is passed to the OnGetData event to retrieve data.

Definition at line 401 of file EventArgs.cs.

Constructor & Destructor Documentation

GetDataArgs()

MyCaffe.trainers.GetDataArgs.GetDataArgs	(	Phase	phase,
		int	nIdx,
		Component	mycaffe,
		Log	log,
		CancelEvent	evtCancel,
		bool	bReset,
		int	nAction = -1,
		bool	bAllowUi = true,
		bool	bGetLabel = false,
		bool	bBatchMode = false,
		IxTrainerGetDataCallback	iOnGetData = null
	)

The constructor.

Parameters

phase	Specifies the phase under which to get the data.
nIdx	Specifies the index of the thread.
mycaffe	Specifies the MyCaffeControl used.
log	Specifies the output log to use.
evtCancel	Specifies the cancel event.
bReset	Specifies to reset the environment.
nAction	Specifies the action to run. If less than zero this parameter is ignored.
bAllowUi	Optionally, specifies whether or not to allow the user interface.
bGetLabel	Optionally, specifies to get the label in addition to the data.
bBatchMode	Optionally, specifies to get the data in batch mode (default = false).
iOnGetData	Optionally, specifies the callback called after rendering the gym output, yet just before displaying it.

Definition at line 430 of file EventArgs.cs.

Property Documentation

Action

int MyCaffe.trainers.GetDataArgs.Action

getset

Returns the action to run. If less than zero, this parameter is ignored.

Definition at line 525 of file EventArgs.cs.

ActivePhase

Phase MyCaffe.trainers.GetDataArgs.ActivePhase

get

Returns the active phase under which to get the data.

Definition at line 466 of file EventArgs.cs.

CancelEvent

CancelEvent MyCaffe.trainers.GetDataArgs.CancelEvent

get

Returns the cancel event.

Definition at line 508 of file EventArgs.cs.

DataReady

ManualResetEvent MyCaffe.trainers.GetDataArgs.DataReady

get

Returns the data ready event that is set once the data has been retrieved. This field is only used when using the OnGetDataAsync event.

Definition at line 475 of file EventArgs.cs.

ExtraProperties

PropertySet MyCaffe.trainers.GetDataArgs.ExtraProperties

getset

Get/set extra properties.

Definition at line 457 of file EventArgs.cs.

GetDataCallback

IxTrainerGetDataCallback MyCaffe.trainers.GetDataArgs.GetDataCallback

get

Returns the OnGetData Callback called just after rendering yet before displaying the gym image.

Definition at line 449 of file EventArgs.cs.

GetLabel

bool MyCaffe.trainers.GetDataArgs.GetLabel

get

Returns whether or not to retrieve the label in addition to the data.

Definition at line 492 of file EventArgs.cs.

Index

int MyCaffe.trainers.GetDataArgs.Index

getset

Returns the index of the thread asking for the gym.

Definition at line 483 of file EventArgs.cs.

MyCaffe

Component MyCaffe.trainers.GetDataArgs.MyCaffe

get

Returns the MyCaffeControl used.

Definition at line 534 of file EventArgs.cs.

OutputLog

Log MyCaffe.trainers.GetDataArgs.OutputLog

get

Returns the output log for general output.

Definition at line 500 of file EventArgs.cs.

Reset

bool MyCaffe.trainers.GetDataArgs.Reset

getset

Returns whether or not to reset the observation environment or not.

Definition at line 542 of file EventArgs.cs.

State

StateBase MyCaffe.trainers.GetDataArgs.State

getset

Specifies the state data of the observations.

Definition at line 516 of file EventArgs.cs.

---

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

• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe.trainers/EventArgs.cs