Package org.eclipse.scanning.api.points.models

Class CompoundModel

java.lang.Object

org.eclipse.scanning.api.AbstractNameable

org.eclipse.scanning.api.points.models.AbstractPointsModel

org.eclipse.scanning.api.points.models.AbstractMultiModel<IScanPointGeneratorModel>

org.eclipse.scanning.api.points.models.CompoundModel

All Implemented Interfaces:

INameable, IScanPathModel, IScanPointGeneratorModel

public class CompoundModel
extends AbstractMultiModel<IScanPointGeneratorModel>

This class is designed to encapsulate the information to required to provide all the locations, with regions of an n-Dimensional scan.

 CompoundModel {
     models:  [ list of models]
     regions: [ list of regions]
     mutators: [ list of mutators ]
 }
 Region {
     roi: geometric roi
     scannables: [ list of scannable names]
 }
 

Example:

 CompoundModel {
     models : [
         {type: SpiralModel
          xAxisName: x
          yAxisName: y
          ...
         }
     ]
     regions : [
        {
          roi : {type: CircularROI
           centre: [0,1]
           radius: 2
          }
          scannables: ["x", "y"]
        }
     ]
     mutators : [
        {
           RandomOffsetMutator: {
            seed: 10
            axes: ["x"]
            max_offset: {
              "x":0.1
            }
           }
        }
     ]
 }


 

Field Summary

Fields inherited from class org.eclipse.scanning.api.points.models.AbstractPointsModel

HARDCODED_UNITS, pcs

Constructor Summary

Constructors

Constructor	Description
CompoundModel()
CompoundModel(List<? extends IScanPointGeneratorModel> ms)
CompoundModel(CompoundModel toCopy)	Returns a copy (clone) of the given CompoundModel.
CompoundModel(IScanPointGeneratorModel... models)
CompoundModel(IScanPointGeneratorModel model, IROI region)

Method Summary

Modifier and Type	Method	Description
void	addData(IScanPointGeneratorModel model, Collection<IROI> rois)	Method to add a model and regions which are assumed to act on the model provided and are assigned to it using its scannable names.
void	addMutators(List<IMutator> mutators)
void	addRegions(Collection<ScanRegion> regions)
boolean	equals(Object obj)
double	getDuration()
List<IMutator>	getMutators()
Collection<ScanRegion>	getRegions()
List<String>	getScannableNames()	The names of the axes which will be scanned by this model.
int	hashCode()
boolean	isContinuous()	If true the scan is continuous if possible, i.e.
void	setData(IScanPointGeneratorModel model, IROI region)
void	setData(IScanPointGeneratorModel model, IROI region, List<String> names)
void	setDuration(double duration)
void	setModelsVarArgs(IScanPointGeneratorModel... models)
void	setMutators(List<IMutator> mutators)
void	setRegions(Collection<ScanRegion> regions)
void	setRegionsVarArgs(ScanRegion... regions)
String	toString()

Methods inherited from class org.eclipse.scanning.api.points.models.AbstractMultiModel

addModel, clear, getFirstModel, getModels, setModels

Methods inherited from class org.eclipse.scanning.api.points.models.AbstractPointsModel

addPropertyChangeListener, getSummary, getUnits, isAlternating, removePropertyChangeListener, setAlternating, setContinuous, setUnits, supportsAlternating, supportsContinuous, supportsRandomOffset, supportsVertical, updateFromPropertiesMap

Methods inherited from class org.eclipse.scanning.api.AbstractNameable

getName, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.scanning.api.INameable

getName, setName

Constructor Details

CompoundModel

public CompoundModel()

CompoundModel

public CompoundModel(CompoundModel toCopy)

Returns a copy (clone) of the given CompoundModel.

Parameters:

toCopy - the model to copy

CompoundModel

public CompoundModel(IScanPointGeneratorModel... models)

CompoundModel

public CompoundModel(List<? extends IScanPointGeneratorModel> ms)

CompoundModel

public CompoundModel(IScanPointGeneratorModel model,
 IROI region)

Method Details

setData

public void setData(IScanPointGeneratorModel model,
 IROI region)

setData

public void setData(IScanPointGeneratorModel model,
 IROI region,
 List<String> names)

addData

public void addData(IScanPointGeneratorModel model,
 Collection<IROI> rois)

Method to add a model and regions which are assumed to act on the model provided and are assigned to it using its scannable names.

Parameters:

model -

rois -

setModelsVarArgs

public void setModelsVarArgs(IScanPointGeneratorModel... models)

getRegions

public Collection<ScanRegion> getRegions()

setRegions

public void setRegions(Collection<ScanRegion> regions)

setRegionsVarArgs

public void setRegionsVarArgs(ScanRegion... regions)

getMutators

public List<IMutator> getMutators()

setMutators

public void setMutators(List<IMutator> mutators)

getDuration

public double getDuration()

setDuration

public void setDuration(double duration)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMultiModel<IScanPointGeneratorModel>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractMultiModel<IScanPointGeneratorModel>

toString

public String toString()

Overrides:

toString in class AbstractMultiModel<IScanPointGeneratorModel>

isContinuous

public boolean isContinuous()

Description copied from interface: IScanPointGeneratorModel

If true the scan is continuous if possible, i.e. the motors continue to move while the detectors are exposed, if false the motors stop at each point for the detectors are exposed. For a scan to be continous, generally it must done by malcolm device, i.e. for a GDA point of view the scan contains exactly one runnable device and that must be a malcolm device. Additionally continuous scanning is only possible for certain path models, e.g. TwoAxisGridPointsModel, where even then the scan will only be continuous in the fast axis, and step in the slow axis, where the x-axis is the fast axis by default.

Specified by:

isContinuous in interface IScanPointGeneratorModel

Overrides:

isContinuous in class AbstractPointsModel

Returns:

true if the scan should be continuous, false otherwise.

addMutators

public void addMutators(List<IMutator> mutators)

addRegions

public void addRegions(Collection<ScanRegion> regions)

getScannableNames

public List<String> getScannableNames()

Description copied from interface: IScanPathModel

The names of the axes which will be scanned by this model.

Specified by:

getScannableNames in interface IScanPathModel

Overrides:

getScannableNames in class AbstractPointsModel

Returns: