Class Props

java.lang.Object
com.xinapse.platform.Props

public final class Props extends Object
The properties used by Jim, collected all in one place.
  • Field Details

    • HTML_FORMAT_OPTION

      public static final org.apache.commons.cli.Option HTML_FORMAT_OPTION
      An Option to list the Properties in HTML format.
    • LICENSE_FILE_PROPERTY

      public static final Props.Property LICENSE_FILE_PROPERTY
      Sets the license file location at run-time.
    • LICENSE_DEBUG_PROPERTY

      public static final Props.Property LICENSE_DEBUG_PROPERTY
      Turns license debugging on.
    • TEXT_MODE_PROPERTY

      public static final Props.Property TEXT_MODE_PROPERTY
      Whether to run in text (non-GUI) mode.
    • GCP_PROPERTY

      public static final Props.Property GCP_PROPERTY
      Whether to run in GCP Clinical Trials mode.
    • POSIX_COMPLIANT_PROPERTY

      public static final Props.Property POSIX_COMPLIANT_PROPERTY
      Whether to allow the creation of only POSIX-compliant file names.
    • UMASK_PROPERTY

      public static final Props.Property UMASK_PROPERTY
      Specifies the file-creation umask.
    • OUTPUT_TYPE_PROPERTY

      public static final Props.Property OUTPUT_TYPE_PROPERTY
      Sets the default output image class.
    • ANZ_75_COMPRESSED_PROPERTY

      public static final Props.Property ANZ_75_COMPRESSED_PROPERTY
      Sets whether Analyze 7.5 images should be stored compressed, or uncompressed.
    • WARN_NEGATIVE_PIXEL_WIDTH_PROPERTY

      public static final Props.Property WARN_NEGATIVE_PIXEL_WIDTH_PROPERTY
      Sets whether the user should be warned about negative pixel widths in Analyze images.
    • WARN_NEGATIVE_PIXEL_HEIGHT_PROPERTY

      public static final Props.Property WARN_NEGATIVE_PIXEL_HEIGHT_PROPERTY
      Sets whether the user should be warned about negative pixel heights in Analyze images.
    • FLIP_NON_FLIPPED_PROPERTY

      public static final Props.Property FLIP_NON_FLIPPED_PROPERTY
      Sets whether to flip non-flipped Analyze 7.5 images.
    • DO_NOT_FLIP_FLIPPED_PROPERTY

      public static final Props.Property DO_NOT_FLIP_FLIPPED_PROPERTY
      Sets whether not to flip flipped Analyze 7.5 images.
    • CREATE_NON_FLIPPED_PROPERTY

      public static final Props.Property CREATE_NON_FLIPPED_PROPERTY
      Sets whether newly-created Analyze 7.5 images should have a non-flipped orientation.
    • NIFTI_ONE_FILE_PROPERTY

      public static final Props.Property NIFTI_ONE_FILE_PROPERTY
      Sets whether NIFTI images should be stored in one file.
    • NIFTI_COMPRESSED_PROPERTY

      public static final Props.Property NIFTI_COMPRESSED_PROPERTY
      Sets whether NIFTI images should be stored compressed.
    • NIFTI_SAVE_FSL_ORIENT_PROPERTY

      public static final Props.Property NIFTI_SAVE_FSL_ORIENT_PROPERTY
      Sets whether NIFTI images should be saved with an orientation that is compatible with FSL.
    • NIFTI_SAVE_SPM_ORIENT_PROPERTY

      public static final Props.Property NIFTI_SAVE_SPM_ORIENT_PROPERTY
      Sets whether NIFTI images should be saved with an orientation that is compatible with SPM.
    • NIFTI_FSL_COMPATIBLE_NIFTI_PROPERTY

      public static final Props.Property NIFTI_FSL_COMPATIBLE_NIFTI_PROPERTY
      Sets whether NIFTI images that have qform and sform orientation both unset should be read as having an increasing a patient left coordinate value with stored pixel data column number, and whether NIFTI images should be prevented from being written without orientation information.
    • UNC_OVERWRITE_PROPERTY

      public static final Props.Property UNC_OVERWRITE_PROPERTY
      Whether to overwrite UNC images without asking.
    • WRITE_NAN_PROPERTY

      public static final Props.Property WRITE_NAN_PROPERTY
      Whethet to write Not-a-Number to image when fitting fails.
    • IMAGE_DEBUG_PROPERTY

      public static final Props.Property IMAGE_DEBUG_PROPERTY
      Whether to turn on debugging in the com.xinapse.image package.
    • MSI_DEBUG_PROPERTY

      public static final Props.Property MSI_DEBUG_PROPERTY
      Whether to turn on debugging in the com.xinapse.multisliceimage package.
    • UNC_DEBUG_PROPERTY

      public static final Props.Property UNC_DEBUG_PROPERTY
      Whether to turn on debugging in the com.xinapse.multisliceimage.unc package.
    • ANZ_DEBUG_PROPERTY

      public static final Props.Property ANZ_DEBUG_PROPERTY
      Whether to turn on debugging in the com.xinapse.multisliceimage.analyze package.
    • DONGLE_DEBUG_PROPERTY

      public static final Props.Property DONGLE_DEBUG_PROPERTY
      Whether to turn on license dongle debugging.
    • DCM_DEBUG_PROPERTY

      public static final Props.Property DCM_DEBUG_PROPERTY
      Whether to turn on general debugging of DICOM images.
    • DUL_DEBUG_PROPERTY

      public static final Props.Property DUL_DEBUG_PROPERTY
      Whether to turn on debugging of the DICOM upper layer.
    • SRV_DEBUG_PROPERTY

      public static final Props.Property SRV_DEBUG_PROPERTY
      Whether to turn on debugging of DICOM services.
    • JPEG_DEBUG_PROPERTY

      public static final Props.Property JPEG_DEBUG_PROPERTY
      Whether to turn on debugging of JPEG image decoding.
    • LOAD_LIBRARY_DEBUG_PROPERTY

      public static final Props.Property LOAD_LIBRARY_DEBUG_PROPERTY
      Whether to turn on debugging of loading libraries.
  • Method Details

    • getUserDir

      public static File getUserDir()
      Returns the current working directory.
      Returns:
      the current working directory.
    • setUserDir

      public static boolean setUserDir(File userDir)
      Sets the current working directory, if the argument is non-null, exists and is a directory.
      Parameters:
      userDir - the current working directory to set.
      Returns:
      whether the current working directory was successfully set.
    • getHomeDir

      public static File getHomeDir()
      Returns the user's home directory.
      Returns:
      the user's home directory.
    • getProperties

      public static List<Props.Property> getProperties()
      Returns a List of non-standard Properties used in this application.
      Returns:
      a List of non-standard Properties used in this application.
    • getDesktopDir

      public static File getDesktopDir()
      Returns the user's Desktop folder as a File, if it exists. Falls back to the user's home directory if the Desktop cannot be determined.
      Returns:
      the user's Desktop folder.
    • getModelsDir

      public static File getModelsDir() throws FileNotFoundException
      Returns the folder that contains all the Tensorflow/Keras models.
      Returns:
      the folder that contains all the Tensorflow/Keras models.
      Throws:
      FileNotFoundException - if the folder can't be found.
    • listProperties

      public static void listProperties(Logger logger, boolean htmlFormat)
      Lists all the non-standard Properties used in this application using a Logger.
      Parameters:
      logger - the Logger for verbose reporting and error messages.
      htmlFormat - whether to list in HTML format.
    • getBooleanProperty

      public static Boolean getBooleanProperty(Props.Property property)
      Returns a Boolean value from a System Property (if the property is set and has a value of either true or false), or null.
      Parameters:
      property - the Props.Property to check.
      Returns:
      a Boolean value if the property is set, or null if not.
    • main

      public static void main(String[] args)
      Program entry point for the Props program. The program lists all non-standard properties used by Jim.
      Parameters:
      args - the command line arguments. Use option --help to see the optional and compulsory program arguments.