### Full Example: Synthetic Image and PSF with Reference Source: https://context7.com/biomedical-imaging-group/deconvolutionlab2/llms.txt A complete command-line example demonstrating the use of synthetic images and PSFs, along with a reference image, for a deconvolution task. ```bash java -jar DeconvolutionLab_2.jar run \ -image synthetic CubeSphericalBeads 5.0 0.2 12.0 12.0 size 96 80 64 intensity 128 \ -psf synthetic Gaussian 2.0 2.0 2.0 size 64 64 64 \ -reference file reference.tif \ -algorithm RL 100 \ -out stack noshow deconvolved \ -path current -monitor console ``` -------------------------------- ### System Settings Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/Controller.html Methods to get and set the system flag. ```APIDOC ## isSystem ### Description Returns the system flag. ### Method public boolean isSystem() ## setSystem ### Description Sets the system flag. ### Method public void setSystem(boolean system) ### Parameters * **system** (boolean) - Required - the system to set ``` -------------------------------- ### printInit Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Config.html Prints the initial configuration to the console. ```APIDOC ## printInit ### Description Prints the initial DeconvolutionLab2 configuration to the console. ### Method Signature public static void printInit() ``` -------------------------------- ### getReference Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/Deconvolution.html Gets the reference signal. ```APIDOC ## getReference ### Description Gets the reference signal. ### Method public RealSignal ### Signature getReference() ``` -------------------------------- ### FISTAPanel.getCommand() Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Gets the command associated with the FISTAPanel. ```APIDOC ## getCommand() ### Description Gets the command associated with the FISTAPanel. ### Method Method ### Endpoint N/A (Java Method) ### Parameters None ### Request Example N/A ### Response N/A ``` -------------------------------- ### Initialization and Help Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Lab.html Methods for initializing the DeconvolutionLab and accessing help. ```APIDOC ## help ### Description Open a web page on the DeconvolutionLab2. ### Method `static void` ### Signature `help()` ## init (Platform) ### Description Initializes the Lab with a given platform. ### Method `static void` ### Signature `init(Platform platform)` ## init (Platform, configFilename) ### Description Initializes the Lab with a given platform and a given configuration file. ### Method `static void` ### Signature `init(Platform platformInit, java.lang.String configFilename)` ``` -------------------------------- ### help() Static Method Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Opens a web page on the DeconvolutionLab2. ```APIDOC ## help() Static Method ### Description Opens a web page providing help and information about DeconvolutionLab2. ### Method `static void help()` ``` -------------------------------- ### ConvolutionPanel.getCommand() Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Gets the command associated with the ConvolutionPanel. ```APIDOC ## getCommand() ### Description Gets the command associated with the ConvolutionPanel. ### Method Method ### Endpoint N/A (Java Method) ### Parameters None ### Request Example N/A ### Response N/A ``` -------------------------------- ### AlgorithmPanel.getCommand() Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Gets the command associated with the AlgorithmPanel. ```APIDOC ## getCommand() ### Description Gets the command associated with the AlgorithmPanel. ### Method Method ### Endpoint N/A (Java Method) ### Parameters None ### Request Example N/A ### Response N/A ``` -------------------------------- ### Initialization Methods Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Lab.html Methods for initializing the DeconvolutionLab2 environment with different configurations. ```APIDOC ## init ### Description Initializes the Lab with a give platform. ### Method `public static void init(Platform platform)` ### Parameters #### Path Parameters - **platform** (Platform) - Required - The platform is ImageJ, ICY, Standalone, or Matlab. ## init ### Description Initializes the Lab with a give platform and a given configuration file. ### Method `public static void init(Platform platformInit, String configFilename)` ### Parameters #### Path Parameters - **platformInit** (Platform) - Required - - **configFilename** (String) - Required - ``` -------------------------------- ### Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/module/dropdownbuttons/ShowImageDropDownButton.html Initializes a new instance of the ShowImageDropDownButton. ```APIDOC ## ShowImageDropDownButton(String moduleName, String text) ### Description Constructs a new ShowImageDropDownButton with the specified module name and text. ### Parameters * **moduleName** (String) - The name of the module. * **text** (String) - The text to display on the button. ``` -------------------------------- ### JSplitButton.getArrowSize() Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Gets the size of the arrow in a JSplitButton. ```APIDOC ## getArrowSize() ### Description Gets the size of the arrow. ### Method Method ### Endpoint N/A (Java Method) ### Parameters None ### Request Example N/A ### Response N/A ``` -------------------------------- ### print Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Config.html Prints the current configuration to the console. ```APIDOC ## print ### Description Prints the current DeconvolutionLab2 configuration to the console. ### Method Signature public static void print() ``` -------------------------------- ### get Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/signal/factory/SignalFactory.html Retrieves a SignalFactory instance by its name. ```APIDOC ## get ### Description Retrieves a SignalFactory instance by its name. ### Method static ### Signature SignalFactory get(String name) ### Parameters #### Path Parameters - **name** (String) - Required - The name of the SignalFactory to retrieve. ``` -------------------------------- ### getName Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/TikhonovMiller.html Gets the name of the TikhonovMiller algorithm. ```APIDOC ## getName ### Description Returns the name of the algorithm. ### Signature public java.lang.String getName() ``` -------------------------------- ### create Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/monitor/Monitors.html Creates a monitor instance based on an abstract monitor. ```APIDOC ## create ### Description Creates a monitor instance based on an abstract monitor. ### Method public static Monitors create(AbstractMonitor monitor) ### Parameters * **monitor** (AbstractMonitor) - The abstract monitor to base the new monitor on. ### Returns * Monitors - A new monitor instance. ``` -------------------------------- ### Config Initialization and Management Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Config.html Methods for initializing, loading, storing, and checking the configuration. ```APIDOC ## init ### Description Initializes the configuration system with a given filename. ### Method `static Config init(String filename)` ### Parameters * **filename** (String) - The path to the configuration file. ## load ### Description Loads the configuration settings. ### Method `static void load()` ## store ### Description Stores the current configuration settings. ### Method `static boolean store()` ## check ### Description Checks the validity of the configuration. ### Method `static boolean check()` ``` -------------------------------- ### getCommand Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/TikhonovRegularizedInverseFilterPanel.html Gets the command identifier for this panel. ```APIDOC ## getCommand ### Description Returns the command string associated with this algorithm panel. ### Method `getCommand()` ### Returns `java.lang.String` - The command identifier. ``` -------------------------------- ### list Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Config.html Lists all available configuration keys. ```APIDOC ## list ### Description Returns a list of all available configuration keys. ### Method Signature public static ArrayList list() ### Returns (ArrayList) - A list of configuration keys. ``` -------------------------------- ### getPath Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/Algorithm.html Gets the path associated with the algorithm. ```APIDOC ## getPath ### Description Gets the path associated with the algorithm. ### Method `getPath()` ### Returns - **String** - The path. ``` -------------------------------- ### getMemory Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/Algorithm.html Gets the memory usage of the algorithm. ```APIDOC ## getMemory ### Description Gets the memory usage of the algorithm. ### Method `getMemory()` ### Returns - **double** - The memory usage. ``` -------------------------------- ### main Method Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/DeconvolutionLab2_Lab.html The entry point for the DeconvolutionLab2 application. ```APIDOC ## main(String[] arg) ### Description The entry point for the DeconvolutionLab2 application. This static method starts the deconvolution process. ### Method `public static void main(java.lang.String[] arg)` ### Parameters #### Path Parameters - **arg** (String[]) - Required - Command-line arguments passed to the application. ``` -------------------------------- ### Instance Methods Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/system/SystemInfo.html Details instance methods available on SystemInfo objects, including event handlers and update/restart functionalities. ```APIDOC ## actionPerformed ### Description Handles action events, typically from UI components. ### Method public void actionPerformed(java.awt.event.ActionEvent e) Specified by: `actionPerformed` in interface `java.awt.event.ActionListener` ## update ### Description Updates the system information. ### Method public void update() ## restart ### Description Restarts the system information component. ### Method public void restart() ## mouseClicked ### Description Handles mouse click events. ### Method public void mouseClicked(java.awt.event.MouseEvent e) Specified by: `mouseClicked` in interface `java.awt.event.MouseListener` ## mousePressed ### Description Handles mouse press events. ### Method public void mousePressed(java.awt.event.MouseEvent e) Specified by: `mousePressed` in interface `java.awt.event.MouseListener` ``` -------------------------------- ### getImage Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/Deconvolution.html Gets the input image signal. ```APIDOC ## getImage ### Description Gets the input image signal. ### Method public RealSignal ### Signature getImage() ``` -------------------------------- ### Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/module/dropdownbuttons/ChooseImageDropDownButton.html Initializes a new instance of the ChooseImageDropDownButton. ```APIDOC ## ChooseImageDropDownButton Constructor ### Description Constructs a new ChooseImageDropDownButton with the specified module name, associated module, and button text. ### Parameters * **moduleName** (String) - The name of the module. * **module** (AbstractImageSelectionModule) - The image selection module associated with this button. * **text** (String) - The text to display on the button. ``` -------------------------------- ### getName Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/Deconvolution.html Gets the name of the deconvolution process. ```APIDOC ## getName ### Description Gets the name of the deconvolution process. ### Method public String ### Signature getName() ``` -------------------------------- ### DeconvolutionLab2 CLI Help and GUI Launch Source: https://context7.com/biomedical-imaging-group/deconvolutionlab2/llms.txt Basic commands to show help or launch the graphical user interface. The 'lab' command opens the full GUI, while 'launch' starts a deconvolution with an interactive progress dialog. ```bash java -jar DeconvolutionLab_2.jar help ``` ```bash java -jar DeconvolutionLab_2.jar lab ``` ```bash java -jar DeconvolutionLab_2.jar lab /path/to/MyConfig.config ``` ```bash java -jar DeconvolutionLab_2.jar fft ``` -------------------------------- ### getOutput Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/Deconvolution.html Gets the output signal from the deconvolution. ```APIDOC ## getOutput ### Description Gets the output signal from the deconvolution. ### Method public RealSignal ### Signature getOutput() ``` -------------------------------- ### getController Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/Deconvolution.html Gets the current deconvolution controller. ```APIDOC ## getController ### Description Gets the current deconvolution controller. ### Method public Controller ### Signature getController() ``` -------------------------------- ### Instance Padding Methods Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/signal/padding/Padding.html Details on instance methods for performing padding and cropping operations. ```APIDOC ## Instance Padding Methods ### pad(int nx, int ny, int nz) **Description**: Pads the signal dimensions according to the current padding configuration. **Parameters**: - **nx** (int) - The size of the extension in the X dimension. - **ny** (int) - The size of the extension in the Y dimension. - **nz** (int) - The size of the extension in the Z dimension. **Returns**: `int[]` - An array representing the padded dimensions. ### pad(Monitors monitors, RealSignal input) **Description**: Pads the input RealSignal using the current padding configuration and provided monitors. **Parameters**: - **monitors** (Monitors) - The monitors to use during the padding process. - **input** (RealSignal) - The input signal to be padded. **Returns**: `RealSignal` - The padded signal. ### crop(Monitors monitors, RealSignal large) **Description**: Crops a larger RealSignal to a smaller size using the current padding configuration and provided monitors. **Parameters**: - **monitors** (Monitors) - The monitors to use during the cropping process. - **large** (RealSignal) - The larger signal to be cropped. **Returns**: `RealSignal` - The cropped signal. ### toString() **Description**: Returns a string representation of the Padding object. **Overrides**: `toString` in class `java.lang.Object` **Returns**: `String` ``` -------------------------------- ### load Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Config.html Loads the configuration. ```APIDOC ## load ### Description Loads the DeconvolutionLab2 configuration. ### Method Signature public static void load() ``` -------------------------------- ### getAlgorithm Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/Deconvolution.html Gets the current deconvolution algorithm. ```APIDOC ## getAlgorithm ### Description Gets the current deconvolution algorithm. ### Method public Algorithm ### Signature getAlgorithm() ``` -------------------------------- ### Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/module/AbstractImageSelectionModule.html Initializes a new instance of the AbstractImageSelectionModule. ```APIDOC ## AbstractImageSelectionModule Constructor ### Description Initializes a new instance of the AbstractImageSelectionModule with a specified name. ### Parameters * **name** (String) - The name for this module. ``` -------------------------------- ### get Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/DL2.html Retrieves an image or data object. ```APIDOC ## get ### Description Retrieves an image or data object. ### Method `static Object get(String image)` ### Parameters * **image** (String) - The identifier of the image or data to retrieve. ``` -------------------------------- ### CustomizedColumn.getColumnClass() Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Gets the class of the column in a customized table. ```APIDOC ## getColumnClass() ### Description Gets the class of the column in a customized table. ### Method Method ### Endpoint N/A (Java Method) ### Parameters None ### Request Example N/A ### Response N/A ``` -------------------------------- ### open Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Imager.html Opens and returns a RealSignal from a specified file. ```APIDOC ## open ### Description Opens and returns a RealSignal from a specified file. ### Method Signature `public abstract RealSignal open(String filename)` ### Parameters * **filename** (String) - The name of the file to open. ### Returns * (RealSignal) - The loaded RealSignal. ``` -------------------------------- ### AbstractModule.getCollapsedPanel() Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Gets the collapsed panel of an abstract module. ```APIDOC ## getCollapsedPanel() ### Description Gets the collapsed panel of an abstract module. ### Method Method ### Endpoint N/A (Java Method) ### Parameters None ### Request Example N/A ### Response N/A ``` -------------------------------- ### ShowMIP Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/output/ShowMIP.html Initializes a new instance of the ShowMIP class with a specified name. ```APIDOC ## ShowMIP Constructor ### Description Initializes a new instance of the ShowMIP class with a specified name. ### Signature `public ShowMIP(java.lang.String name)` ### Parameters * **name** (java.lang.String) - The name to assign to the ShowMIP instance. ``` -------------------------------- ### Padding.getByName(String) Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Gets a Padding object by its name. ```APIDOC ## getByName(String name) ### Description Gets a Padding object by its name. ### Method Static method ### Endpoint N/A (Java Method) ### Parameters * **name** (String) - The name of the Padding. ### Request Example N/A ### Response N/A ``` -------------------------------- ### Initialize Platform and Open Files with Lab Class Source: https://context7.com/biomedical-imaging-group/deconvolutionlab2/llms.txt Initializes the DeconvolutionLab2 platform for different environments and opens image files from disk or directories. Supports custom configuration paths and regex filtering for directory scanning. ```java import deconvolutionlab.Lab; import deconvolutionlab.Platform; import deconvolutionlab.Imager; import deconvolutionlab.monitor.Monitors; import signal.RealSignal; // Initialize for a specific platform Lab.init(Platform.STANDALONE); // or IMAGEJ, ICY, MATLAB Lab.init(Platform.STANDALONE, "/path/to/DeconvolutionLab2.config"); // Open a TIFF file from disk RealSignal image = Lab.openFile("/data/cell_stack.tif"); // Open a directory of 2D slices into a 3D stack RealSignal stack = Lab.openDir("/data/slices/"); // With a regex filter: RealSignal filtered = Lab.openDir(Monitors.createDefaultMonitor(), "/data/slices/ pattern .*_z\\d+\\.tif"); ``` -------------------------------- ### signal.Constraint.getByName(String) Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Gets a Constraint object by its name. ```APIDOC ## getByName(String name) ### Description Gets a Constraint object by its name. ### Method Static method ### Endpoint N/A (Java Method) ### Parameters * **name** (String) - The name of the Constraint. ### Request Example N/A ### Response N/A ``` -------------------------------- ### Utility Methods Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Lab.html Utility methods for accessing help, checking FFT, and creating image containers. ```APIDOC ## help ### Description Open a web page on the DeconvolutionLab2. ### Method `public static void help()` ## checkFFT ### Description Checks the installed FFT libraries on a small (40, 30, 20) signal. ### Method `public static void checkFFT(Monitors monitors)` ### Parameters #### Path Parameters - **monitors** (Monitors) - Required - ## createContainer ### Description Creates an image container. ### Method `public static Imager.ContainerImage createContainer(Monitors monitors, String title)` ### Parameters #### Path Parameters - **monitors** (Monitors) - Required - - **title** (String) - Required - ``` -------------------------------- ### Algorithm Configuration Methods Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/Algorithm.html This section details the methods available to configure the Algorithm object, including setting FFT, monitors, normalization, memory footprint, outputs, padding, parameters, path, reference signal, residual minimum, statistics, time limit, and verbosity. ```APIDOC ## setFFT ### Description Sets the Fast Fourier Transform (FFT) implementation to be used. ### Method `setFFT(AbstractFFT fft)` ### Parameters * **fft** (AbstractFFT) - The FFT implementation to set. ``` ```APIDOC ## setMonitors ### Description Sets the monitors for observing the deconvolution process. ### Method `setMonitors(Monitors monitors)` ### Parameters * **monitors** (Monitors) - The monitors object to set. ``` ```APIDOC ## setNormalizationPSF ### Description Sets the normalization factor for the Point Spread Function (PSF). ### Method `setNormalizationPSF(double normalizationPSF)` ### Parameters * **normalizationPSF** (double) - The normalization value for the PSF. ``` ```APIDOC ## setOptimizedMemoryFootprint ### Description Enables or disables an optimized memory footprint for the algorithm. ### Method `setOptimizedMemoryFootprint(boolean optimizedMemoryFootprint)` ### Parameters * **optimizedMemoryFootprint** (boolean) - True to enable optimized memory footprint, false otherwise. ``` ```APIDOC ## setOuts ### Description Sets the list of outputs for the deconvolution process. ### Method `setOuts(ArrayList outs)` ### Parameters * **outs** (ArrayList) - The list of output objects to set. ``` ```APIDOC ## setPadding ### Description Sets the padding strategy for the deconvolution algorithm. ### Method `setPadding(Padding padding)` ### Parameters * **padding** (Padding) - The padding object to set. ``` ```APIDOC ## setParameters ### Description Sets the deconvolution algorithm parameters. ### Method `setParameters(double... params)` ### Parameters * **params** (double...) - A variable number of double parameters. ``` ```APIDOC ## setPath ### Description Sets the path for the algorithm, potentially for output files or resources. ### Method `setPath(String path)` ### Parameters * **path** (String) - The path to set. ``` ```APIDOC ## setReference ### Description Sets the reference signal for the deconvolution process. ### Method `setReference(RealSignal ref)` ### Parameters * **ref** (RealSignal) - The reference signal to set. ``` ```APIDOC ## setResiduMin ### Description Sets the minimum residual value for the deconvolution process. ### Method `setResiduMin(double residuMin)` ### Parameters * **residuMin** (double) - The minimum residual value. ``` ```APIDOC ## setStats ### Description Initializes or sets the statistics object for the algorithm. Overloaded versions allow for different initialization methods. ### Method `setStats()` `setStats(Stats stats)` `setStats(String name)` ### Parameters * `setStats()`: No parameters. * `setStats(Stats stats)`: **stats** (Stats) - The statistics object to set. * `setStats(String name)`: **name** (String) - The name to associate with the statistics. ``` ```APIDOC ## setTimeLimit ### Description Sets the time limit for the deconvolution process. ### Method `setTimeLimit(double timeLimit)` ### Parameters * **timeLimit** (double) - The time limit in seconds. ``` ```APIDOC ## setVerbose ### Description Sets the verbosity level for the deconvolution process. ### Method `setVerbose(Verbose verbose)` ### Parameters * **verbose** (Verbose) - The verbosity level to set. ``` ```APIDOC ## setWavelets ### Description Sets the name of the wavelets to be used in the deconvolution process. ### Method `setWavelets(String waveletsName)` ### Parameters * **waveletsName** (String) - The name of the wavelets. ``` ```APIDOC ## showStats ### Description Displays the statistics of the deconvolution process. Overloaded versions allow displaying all stats or stats by name. ### Method `showStats()` `showStats(String name)` ### Parameters * `showStats()`: No parameters. * `showStats(String name)`: **name** (String) - The name of the statistics to display. ``` ```APIDOC ## toString ### Description Returns a string representation of the Algorithm object. ### Method `toString()` ``` -------------------------------- ### Apodization.getByName(String) Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Gets an Apodization object by its name. ```APIDOC ## getByName(String name) ### Description Gets an Apodization object by its name. ### Method Static method ### Endpoint N/A (Java Method) ### Parameters * **name** (String) - The name of the Apodization. ### Request Example N/A ### Response N/A ``` -------------------------------- ### SystemUsage.getAvailableSpace() Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Gets the available disk space on the system. ```APIDOC ## getAvailableSpace() ### Description Gets the available disk space on the system. ### Method Static method ### Endpoint N/A (Java Method) ### Parameters None ### Request Example N/A ### Response N/A ``` -------------------------------- ### LicenceModule Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/module/LicenceModule.html Initializes a new instance of the LicenceModule. ```APIDOC ## LicenceModule Constructor ### Description Initializes a new instance of the LicenceModule. ### Signature public LicenceModule() ``` -------------------------------- ### launch Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/DL2.html Launches a process or application. ```APIDOC ## launch ### Description Launches a process or application. ### Method `static void launch(String command)` ### Parameters * **command** (String) - The command to launch. ``` -------------------------------- ### getDocumentation Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/wavelets/spline/Spline3Wavelets.html Gets the documentation string for the wavelet transform. ```APIDOC ## getDocumentation ### Description Retrieves the documentation string for the wavelet transform. ### Method `java.lang.String getDocumentation()` ### Response #### Success Response (200) - **documentation** (string) - The documentation string. ``` -------------------------------- ### Get Energy Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/signal/RealSignal.html Calculates and returns the energy of the signal. ```APIDOC ## RealSignal.getEnergy() ### Description Calculates and returns the energy of the signal. ### Method public float getEnergy() ``` -------------------------------- ### ShowOrtho Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/output/ShowOrtho.html Initializes a new instance of the ShowOrtho class with the specified name. ```APIDOC ## ShowOrtho Constructor ### Description Initializes a new instance of the ShowOrtho class. ### Signature `public ShowOrtho(java.lang.String name)` ### Parameters * **name** (java.lang.String) - The name for the ShowOrtho instance. ``` -------------------------------- ### AbstractModule Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/module/AbstractModule.html Initializes a new instance of the AbstractModule. ```APIDOC ## AbstractModule() ### Description Constructs a new AbstractModule. ### Constructor `public AbstractModule()` ``` -------------------------------- ### getParameter Method Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/signal/apodization/HammingApodization.html Gets the parameter string for the apodization. ```APIDOC ## getParameter() ### Description Returns the parameter string for the Hamming apodization. ### Method `public String getParameter()` ### Returns * (String) - The parameter string. ``` -------------------------------- ### show (RealSignal, z-slice, overlay) Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Imager.html Displays a RealSignal at a specific z-slice with overlay lines. ```APIDOC ## show (RealSignal, z-slice, overlay) ### Description Displays a real signal at a specified z-depth, with the option to add overlay lines. ### Method `void show(RealSignal signal, String title, Imager.Type type, int z, ArrayList overlayLines)` ### Parameters - **signal** (RealSignal) - The real signal data to display. - **title** (String) - The title for the display window. - **type** (Imager.Type) - The type of image representation. - **z** (int) - The z-coordinate (slice index) to display. - **overlayLines** (ArrayList) - A list of lines to draw as overlays on the image. ``` -------------------------------- ### getVerbose Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/monitor/Monitors.html Gets the current verbosity level of the monitor. ```APIDOC ## getVerbose ### Description Gets the current verbosity level of the monitor. ### Method public Verbose getVerbose() ### Returns * Verbose - The current verbosity level. ``` -------------------------------- ### getActiveImage Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Lab.html Gets the name of the currently active image. ```APIDOC ## getActiveImage ### Description Gets the name of the currently active image. ### Method Signature public static String getActiveImage() ### Returns - **String** - The name of the active image. ``` -------------------------------- ### ReferenceModule Methods Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/module/ReferenceModule.html This section details the instance methods directly available on the ReferenceModule. ```APIDOC ## ReferenceModule ### Description Provides access to various methods for managing and interacting with reference data within the DeconvolutionLab2 module. ### Methods - **buildExpandedPanel()** - Description: Builds the expanded panel for the module. - Return Type: `javax.swing.JPanel` - **close()** - Description: Closes the module. - Return Type: `void` - **edit()** - Description: Edits the module's content. - Return Type: `void` - **expand()** - Description: Expands the module view. - Return Type: `void` - **getCommand()** - Description: Retrieves the command associated with the module. - Return Type: `java.lang.String` - **setReference(boolean doReference)** - Description: Sets the reference status for the module. - Parameters: - **doReference** (boolean) - Required - Indicates whether to set as reference. - Return Type: `void` - **update()** - Description: Updates the module's state. - Return Type: `void` ``` -------------------------------- ### getSelectedImage Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Imager.html Gets the name of the currently selected image. ```APIDOC ## getSelectedImage ### Description Gets the name of the currently selected image. ### Method Signature `public abstract String getSelectedImage()` ### Returns * (String) - The name of the selected image. ``` -------------------------------- ### ShowPlanar Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/output/ShowPlanar.html Initializes a new instance of the ShowPlanar class with the specified name. ```APIDOC ## ShowPlanar(String name) ### Description Constructs a new ShowPlanar object with the given name. ### Constructor `public ShowPlanar(java.lang.String name)` ### Parameters * **name** (java.lang.String) - The name to assign to this ShowPlanar instance. ``` -------------------------------- ### OutputDialog Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/dialog/OutputDialog.html Initializes a new instance of the OutputDialog class. ```APIDOC ## OutputDialog Constructor ### Description Initializes a new instance of the OutputDialog class. ### Parameters * **view** (Output.View) - The view to associate with the dialog. * **snapshot** (int) - The snapshot identifier. ``` -------------------------------- ### getParameters Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/TikhonovMiller.html Gets the current parameters of the TikhonovMiller algorithm. ```APIDOC ## getParameters ### Description Returns an array of the current parameters of the algorithm. ### Signature public double[] getParameters() ``` -------------------------------- ### getParametersAsString Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/Algorithm.html Gets the current parameters of the algorithm as a string. ```APIDOC ## getParametersAsString ### Description Gets the current parameters of the algorithm as a string. ### Method `getParametersAsString()` ### Returns - **String** - A string representation of the current parameters. ``` -------------------------------- ### ShowStack Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/output/ShowStack.html Initializes a new instance of the ShowStack class with the specified name. ```APIDOC ## ShowStack(String name) ### Description Constructs a ShowStack object with a given name. ### Method Signature `public ShowStack(java.lang.String name)` ### Parameters * **name** (java.lang.String) - Required - The name for the ShowStack instance. ``` -------------------------------- ### getIterations Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/Algorithm.html Gets the current number of iterations for the algorithm. ```APIDOC ## getIterations ### Description Gets the current number of iterations for the algorithm. ### Method `getIterations()` ### Returns - **int** - The current number of iterations. ``` -------------------------------- ### Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/system/AbstractMeter.html Initializes a new instance of the AbstractMeter class with a specified width. ```APIDOC ## AbstractMeter(int width) ### Description Constructs an AbstractMeter with the given width. ### Parameters #### Path Parameters - **width** (int) - The width of the meter. ``` -------------------------------- ### getEpsilon Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/Algorithm.html Gets the epsilon value used in the algorithm. ```APIDOC ## getEpsilon ### Description Gets the epsilon value used in the algorithm. ### Method `getEpsilon()` ### Returns - **double** - The epsilon value. ``` -------------------------------- ### help Method Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/DL2.html Displays help information for DeconvolutionLab2. ```APIDOC ## help ### Description Displays help information for DeconvolutionLab2. ### Method Signature `static void help()` ### Response This method does not return a value. ``` -------------------------------- ### FISTA Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/FISTA.html Initializes the FISTA algorithm with specified parameters. ```APIDOC ## FISTA Constructor ### Description Initializes the FISTA algorithm with the maximum number of iterations, gamma, lambda, wavelet name, and scale. ### Signature `public FISTA(int iterMax, double gamma, double lambda, java.lang.String waveletsName, int scale)` ### Parameters * **iterMax** (int) - Maximum number of iterations. * **gamma** (double) - Gamma parameter. * **lambda** (double) - Lambda parameter. * **waveletsName** (java.lang.String) - Name of the wavelets to be used. * **scale** (int) - Scale parameter. ``` -------------------------------- ### getCommand Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/Deconvolution.html Gets the command string used for deconvolution. ```APIDOC ## getCommand ### Description Gets the command string used for deconvolution. ### Method public String ### Signature getCommand() ``` -------------------------------- ### getMonitors Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/Deconvolution.html Gets the monitors associated with the deconvolution process. ```APIDOC ## getMonitors ### Description Gets the monitors associated with the deconvolution process. ### Method public Monitors ### Signature getMonitors() ``` -------------------------------- ### FISTA Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/FISTA.html Initializes the FISTA algorithm with specified parameters. ```APIDOC ## FISTA Constructor ### Description Initializes the FISTA algorithm with the maximum number of iterations, the step size (gamma), the regularization parameter (lambda), the name of the wavelets to be used, and the scale. ### Parameters * **iterMax** (int) - The maximum number of iterations. * **gamma** (double) - The step size parameter. * **lambda** (double) - The regularization parameter. * **waveletsName** (java.lang.String) - The name of the wavelets to use. * **scale** (int) - The scale parameter for wavelets. ``` -------------------------------- ### get Method Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/DL2.html Retrieves an image based on its name. ```APIDOC ## get ### Description Retrieves an image based on its name. ### Method Signature `static java.lang.Object get(java.lang.String image)` ### Parameters * `image` (java.lang.String) - The name of the image to retrieve. ### Response * `java.lang.Object` - The requested image data. ``` -------------------------------- ### RuntimeInfoPanel Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/system/RuntimeInfoPanel.html Initializes a new instance of the RuntimeInfoPanel with a specified rate. ```APIDOC ## RuntimeInfoPanel Constructor ### Description Initializes a new instance of the RuntimeInfoPanel with a specified rate. ### Parameters * **rate** (long) - The rate to initialize the panel with. ``` -------------------------------- ### Padding.getByShortname(String) Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Gets a Padding object by its short name. ```APIDOC ## getByShortname(String shortname) ### Description Gets a Padding object by its short name. ### Method Static method ### Endpoint N/A (Java Method) ### Parameters * **shortname** (String) - The short name of the Padding. ### Request Example N/A ### Response N/A ``` -------------------------------- ### Utility Methods Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Config.html Utility methods for printing and listing configuration information. ```APIDOC ## print ### Description Prints the current configuration. ### Method `static void print()` ## printInit ### Description Prints the initial configuration. ### Method `static void printInit()` ## list ### Description Lists all available configuration keys. ### Method `static java.util.ArrayList list()` ``` -------------------------------- ### Apodization.getByShortname(String) Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Gets an Apodization object by its short name. ```APIDOC ## getByShortname(String shortname) ### Description Gets an Apodization object by its short name. ### Method Static method ### Endpoint N/A (Java Method) ### Parameters * **shortname** (String) - The short name of the Apodization. ### Request Example N/A ### Response N/A ``` -------------------------------- ### DirectoryModule Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/module/DirectoryModule.html Initializes a new instance of the DirectoryModule. ```APIDOC ## DirectoryModule Constructor ### Description Initializes a new instance of the DirectoryModule. ### Method public DirectoryModule() ``` -------------------------------- ### Constraint.getByName(String) Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/index-all.html Gets a Constraint enum constant by its name. ```APIDOC ## getByName(String name) ### Description Gets a Constraint enum constant by its name. ### Method Static method ### Endpoint N/A (Java Method) ### Parameters * **name** (String) - The name of the Constraint. ### Request Example N/A ### Response N/A ``` -------------------------------- ### Get Default Wavelets Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/wavelets/Wavelets.html Retrieves the default AbstractWavelets object. ```APIDOC ## getDefaultWavelets ### Description Retrieves the default AbstractWavelets object. ### Method GET ### Endpoint /wavelets/default ### Parameters None ### Response #### Success Response (200) - **defaultWavelet** (AbstractWavelets) - The default AbstractWavelets object. ### Response Example ```json { "defaultWavelet": { "name": "Haar", "description": "Haar wavelet" } } ``` ``` -------------------------------- ### create Method Overloads Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/module/AbstractModule.html Methods for creating and initializing the module with various configurations. ```APIDOC ## create(String name) ### Description Creates the module with a given name. ### Method `public void create(java.lang.String name)` ``` ```APIDOC ## create(String name, String key) ### Description Creates the module with a given name and key. ### Method `public void create(java.lang.String name, java.lang.String key)` ``` ```APIDOC ## create(String name, String key, AbstractDropDownButton button1) ### Description Creates the module with a given name, key, and a dropdown button. ### Method `public void create(java.lang.String name, java.lang.String key, deconvolutionlab.module.dropdownbuttons.AbstractDropDownButton button1)` ``` ```APIDOC ## create(String name, String key, AbstractDropDownButton button1, AbstractDropDownButton button2) ### Description Creates the module with a given name, key, and two dropdown buttons. ### Method `public void create(java.lang.String name, java.lang.String key, deconvolutionlab.module.dropdownbuttons.AbstractDropDownButton button1, deconvolutionlab.module.dropdownbuttons.AbstractDropDownButton button2)` ``` ```APIDOC ## create(String name, String key, String action) ### Description Creates the module with a given name, key, and an action string. ### Method `public void create(java.lang.String name, java.lang.String key, java.lang.String action)` ``` ```APIDOC ## create(String name, String key, String action, AbstractDropDownButton button1) ### Description Creates the module with a given name, key, an action string, and a dropdown button. ### Method `public void create(java.lang.String name, java.lang.String key, java.lang.String action, deconvolutionlab.module.dropdownbuttons.AbstractDropDownButton button1)` ``` -------------------------------- ### LanguageModule Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/module/LanguageModule.html Initializes a new instance of the LanguageModule. ```APIDOC ## LanguageModule Constructor ### Description Constructs a new LanguageModule. ### Constructor `public LanguageModule()` ``` -------------------------------- ### Get All Wavelets Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/wavelets/Wavelets.html Retrieves a list of all available AbstractWavelets objects. ```APIDOC ## getWavelets ### Description Retrieves a list of all available AbstractWavelets objects. ### Method GET ### Endpoint /wavelets ### Parameters None ### Response #### Success Response (200) - **wavelets** (ArrayList) - A list of AbstractWavelets objects. ### Response Example ```json { "wavelets": [ { "name": "Haar", "description": "Haar wavelet" }, { "name": "Daubechies4", "description": "Daubechies 4 wavelet" } ] } ``` ``` -------------------------------- ### show(Monitors monitors, RealSignal signal, String title, Imager.Type type, int z, ArrayList overlayLines) Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/Lab.html Displays a real 3D signal with advanced options including monitors, image type, z-slice, and overlay lines. ```APIDOC ## show(Monitors monitors, RealSignal signal, String title, Imager.Type type, int z, ArrayList overlayLines) ### Description Displays a real 3D signal with advanced options including monitors, image type, z-slice, and overlay lines. ### Method static void ### Parameters - **monitors** (Monitors) - The monitors to associate with the display. - **signal** (RealSignal) - The 3D signal to display. - **title** (String) - The title for the display. - **type** (Imager.Type) - The type of imager. - **z** (int) - The z-slice index. - **overlayLines** (ArrayList) - A list of lines to overlay on the image. ``` -------------------------------- ### getRealX Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/signal/ComplexSignal.html Gets the real component at a specific y and z index. ```APIDOC ## getRealX ### Description Retrieves the real component of the signal at the specified y and z indices. ### Signature `float[] getRealX(int j, int k)` ### Parameters * **j** (int) - The index in the y-dimension. * **k** (int) - The index in the z-dimension. ``` -------------------------------- ### run Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/DL2.html Executes a command or process. ```APIDOC ## run (Overload 1) ### Description Executes a command. ### Method `static void run(String command)` ### Parameters * **command** (String) - The command to execute. ``` ```APIDOC ## run (Overload 2) ### Description Runs a deconvolution process on an image with a specified algorithm. ### Method `static Object run(Object arrayImage, Object arrayPSF, String algo)` ### Parameters * **arrayImage** (Object) - The input image data. * **arrayPSF** (Object) - The Point Spread Function (PSF) data. * **algo** (String) - The deconvolution algorithm to use. ``` -------------------------------- ### getImagZ Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/signal/ComplexSignal.html Gets the imaginary component at a specific x and y index. ```APIDOC ## getImagZ ### Description Retrieves the imaginary component of the signal at the specified x and y indices. ### Signature `float[] getImagZ(int i, int j)` ### Parameters * **i** (int) - The index in the x-dimension. * **j** (int) - The index in the y-dimension. ``` -------------------------------- ### StarkParker Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/StarkParker.html Initializes the StarkParker algorithm with maximum iterations and a gamma value. ```APIDOC ## StarkParker Constructor ### Description Initializes the StarkParker algorithm with maximum iterations and a gamma value. ### Signature public StarkParker(int iterMax, double gamma) ``` -------------------------------- ### getImagXYZ Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/signal/ComplexSignal.html Gets the entire imaginary component as a 1D array. ```APIDOC ## getImagXYZ ### Description Retrieves the entire imaginary component of the complex signal as a 1D array. ### Signature `float[] getImagXYZ()` ``` -------------------------------- ### getImagX Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/signal/ComplexSignal.html Gets the imaginary component at a specific y and z index. ```APIDOC ## getImagX ### Description Retrieves the imaginary component of the signal at the specified y and z indices. ### Signature `float[] getImagX(int j, int k)` ### Parameters * **j** (int) - The index in the y-dimension. * **k** (int) - The index in the z-dimension. ``` -------------------------------- ### ICTMPanel Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/ICTMPanel.html Initializes a new instance of the ICTMPanel class. ```APIDOC ## ICTMPanel() ### Description Constructs a new ICTMPanel. ### Constructor `ICTMPanel()` ``` -------------------------------- ### getParameter Method Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/signal/apodization/UniformApodization.html Gets the parameter string for the apodization method. ```APIDOC ## getParameter() ### Description Returns the parameter string for the apodization method. This method is specified by the AbstractApodization class. ### Method Signature `String getParameter()` ``` -------------------------------- ### OutputModule Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/module/OutputModule.html Initializes a new instance of the OutputModule class. ```APIDOC ## OutputModule() ### Description Constructs a new OutputModule. ### Constructor `public OutputModule()` ``` -------------------------------- ### RichardsonLucyTV Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/RichardsonLucyTV.html Initializes the RichardsonLucyTV algorithm with specified maximum iterations and regularization factor. ```APIDOC ## RichardsonLucyTV(int iterMax, double lambda) ### Description Constructs a RichardsonLucyTV object with the given maximum number of iterations and regularization factor. ### Parameters #### Path Parameters - **iterMax** (int) - Required - The maximum number of iterations for the deconvolution process. - **lambda** (double) - Required - The regularization factor for the Total Variation component. ``` -------------------------------- ### Get Default Apodization Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/signal/apodization/Apodization.html Retrieves the default apodization implementation. ```APIDOC ## getDefault ### Description Retrieves the default apodization implementation. ### Method public static AbstractApodization getDefault() ### Returns The default AbstractApodization object. ``` -------------------------------- ### Static Methods Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/system/SystemInfo.html Provides documentation for static methods that can be called directly on the SystemInfo class. ```APIDOC ## activate ### Description Activates the system information component. ### Method public static void activate() ## close ### Description Closes the system information component. ### Method public static void close() ``` -------------------------------- ### Get All Apodizations Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/signal/apodization/Apodization.html Retrieves a list of all available apodization implementations. ```APIDOC ## getApodizations ### Description Retrieves a list of all available apodization implementations. ### Method public static java.util.ArrayList getApodizations() ### Returns An ArrayList containing AbstractApodization objects. ``` -------------------------------- ### getShortname Method Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/signal/apodization/HammingApodization.html Gets the short name of the apodization method. ```APIDOC ## getShortname() ### Description Returns the short name of the Hamming apodization. ### Method `public String getShortname()` ### Returns * (String) - The short name "Hamming". ``` -------------------------------- ### ShowFigure Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolutionlab/output/ShowFigure.html Initializes a new instance of the ShowFigure class with a specified name. ```APIDOC ## ShowFigure(String name) ### Description Constructs a ShowFigure object with the given name. ### Constructor `public ShowFigure(java.lang.String name)` ### Parameters * **name** (java.lang.String) - The name to assign to the ShowFigure instance. ``` -------------------------------- ### getName Method Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/signal/apodization/HammingApodization.html Gets the full name of the apodization method. ```APIDOC ## getName() ### Description Returns the full name of the Hamming apodization. ### Method `public String getName()` ### Returns * (String) - The name "Hamming". ``` -------------------------------- ### RichardsonLucyTV Constructor Source: https://github.com/biomedical-imaging-group/deconvolutionlab2/blob/master/doc/deconvolution/algorithm/RichardsonLucyTV.html Initializes the RichardsonLucyTV deconvolution algorithm with maximum iterations and a regularization parameter. ```APIDOC ## RichardsonLucyTV Constructor ### Description Initializes the RichardsonLucyTV deconvolution algorithm. ### Parameters * **iterMax** (int) - The maximum number of iterations for the deconvolution process. * **lambda** (double) - The regularization parameter for Total Variation (TV). ### Method Signature ```java public RichardsonLucyTV(int iterMax, double lambda) ``` ```