Method Detail

• setTarget

  boolean setTarget(ImgPlus<T> img,
                    Map<String,Object> settings)

  Configure this factory to operate on the given source image (possibly 5D), with the given settings map.

  Also checks the validity of the given settings map for this factory. If check fails, return false, an error message can be obtained through getErrorMessage().

  Parameters:

  img - the ImgPlus to operate on, possible 5D.

  settings - the settings map, must be suitable for this detector factory.

  Returns:

  false is the given settings map is not suitable for this detector factory.

  See Also:

  getErrorMessage()

• getErrorMessage

  String getErrorMessage()

  Returns a meaningful error message for the last action on this factory.

  See Also:

  setTarget(ImgPlus, Map), marshall(Map, Element), unmarshall(Element, Map)

• marshall

  boolean marshall(Map<String,Object> settings,
                   org.jdom2.Element element)

  Marshalls a settings map to a JDom element, ready for saving to XML. The element is updated with new attributes.

  Only parameters specific to the specific detector factory are marshalled. The element also always receive an attribute named that saves the target SpotDetectorFactory key.

  Returns:

  true if marshalling was successful. If not, check getErrorMessage()

• unmarshall

  boolean unmarshall(org.jdom2.Element element,
                     Map<String,Object> settings)

  Un-marshalls a JDom element to update a settings map.

  Parameters:

  element - the JDom element to read from.

  settings - the map to update. Is cleared prior to updating, so that it contains only the parameters specific to the target detector factory.

  Returns:

  true if un-marshalling was successful. If not, check getErrorMessage()

• getDetectorConfigurationPanel

  ConfigurationPanel getDetectorConfigurationPanel(Settings settings,
                                                   Model model)

  Returns a new GUI panel able to configure the settings suitable for this specific detector factory.

  Parameters:

  settings - the current settings, used to get info to display on the GUI panel.

  model - the current model, used to get info to display on the GUI panel.

• getDefaultSettings

  Map<String,Object> getDefaultSettings()

  Returns a new default settings map suitable for the target detector. Settings are instantiated with default values.

  Returns:

  a new map.

• checkSettings

  boolean checkSettings(Map<String,Object> settings)

  Check that the given settings map is suitable for target detector.

  Parameters:

  settings - the map to test.

  Returns:

  true if the settings map is valid.

• has2Dsegmentation

  default boolean has2Dsegmentation()

  Return true for the detectors that can provide a spot with a 2D SpotRoi when they operate on 2D images.

  This flag may be used by clients to exploit the fact that the spots created with this detector will have a contour that can be used e.g. to compute morphological features. The default is false, indicating that this detector provides spots as a X, Y, Z, radius tuple.

  Returns:

  true if the spots created by this detector have a 2D contour.