/*
* #%L
* ImageJ software for multidimensional image processing and analysis.
* %%
* Copyright (C) 2009 - 2014 Board of Regents of the University of
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
* Institute of Molecular Cell Biology and Genetics.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package net.imagej;
import io.scif.SCIFIO;
import java.util.Collection;
import net.imagej.animation.AnimationService;
import net.imagej.app.ImageJApp;
import net.imagej.display.ImageDisplayService;
import net.imagej.display.OverlayService;
import net.imagej.display.ScreenCaptureService;
import net.imagej.display.WindowService;
import net.imagej.legacy.LegacyService;
import net.imagej.lut.LUTService;
import net.imagej.measure.MeasurementService;
import net.imagej.measure.StatisticsService;
import net.imagej.operator.CalculatorService;
import net.imagej.ops.OpService;
import net.imagej.render.RenderingService;
import net.imagej.sampler.SamplerService;
import net.imagej.threshold.ThresholdService;
import net.imagej.updater.UpdateService;
import net.imagej.updater.UploaderService;
import org.scijava.AbstractGateway;
import org.scijava.Context;
import org.scijava.Gateway;
import org.scijava.plugin.Plugin;
import org.scijava.service.Service;
import org.scijava.ui.UIService;
/**
* Main entry point into ImageJ. This class enables working with ImageJ services
* in a simple way, while retaining extensibility (i.e., access to third-party
* services).
*
* @author Curtis Rueden
*/
@Plugin(type = Gateway.class)
public class ImageJ extends AbstractGateway {
/** SCIFIO gateway instance, for access to SCIFIO services. */
private SCIFIO scifio;
// -- Constructors --
/** Creates a new ImageJ application context with all available services. */
public ImageJ() {
// TODO: Consider whether to restrict available services
// to SciJava, SCIFIO and ImageJ by default.
this(new Context());
}
/**
* Creates a new ImageJ application context.
*
* @param empty If true, the context will be empty; otherwise, it will be
* initialized with all available services.
*/
public ImageJ(final boolean empty) {
this(new Context(empty));
}
/**
* Creates a new ImageJ application context with the specified services (and
* any required service dependencies).
* <p>
* <b>Developer's note:</b> This constructor's argument is raw (i.e.,
* {@code Class...} instead of {@code Class<? extends Service>...}) because
* otherwise, downstream invocations (e.g.,
* {@code new ImageJ(DisplayService.class)}) yield the potentially confusing
* warning:
* </p>
* <blockquote>Type safety: A generic array of Class<? extends Service> is
* created for a varargs parameter</blockquote>
* <p>
* To avoid this, we have opted to use raw types and suppress the relevant
* warning here instead.
* </p>
*
* @param serviceClasses A list of types that implement the {@link Service}
* interface (e.g., {@code DisplayService.class}).
* @throws ClassCastException If any of the given arguments do not implement
* the {@link Service} interface.
*/
@SuppressWarnings({ "rawtypes" })
public ImageJ(final Class... serviceClasses) {
this(new Context(serviceClasses));
}
/**
* Creates a new ImageJ application context with the specified services (and
* any required service dependencies).
*
* @param serviceClasses A collection of types that implement the
* {@link Service} interface (e.g., {@code DisplayService.class}).
*/
public ImageJ(final Collection<Class<? extends Service>> serviceClasses) {
this(new Context(serviceClasses));
}
/**
* Creates a new ImageJ application context which wraps the given existing
* SciJava context.
*
* @see Context
*/
public ImageJ(final Context context) {
super(ImageJApp.NAME, context);
scifio = new SCIFIO(context);
}
// -- ImageJ methods - gateways --
public SCIFIO scifio() {
return scifio;
}
// -- ImageJ methods - services --
public AnimationService animation() {
return get(AnimationService.class);
}
public CalculatorService calculator() {
return get(CalculatorService.class);
}
public DatasetService dataset() {
return get(DatasetService.class);
}
public ImageDisplayService imageDisplay() {
return get(ImageDisplayService.class);
}
public LegacyService legacy() {
return get(LegacyService.class);
}
public LUTService lut() {
return get(LUTService.class);
}
public MeasurementService measurement() {
return get(MeasurementService.class);
}
public OpService op() {
return get(OpService.class);
}
public OverlayService overlay() {
return get(OverlayService.class);
}
public RenderingService rendering() {
return get(RenderingService.class);
}
public SamplerService sampler() {
return get(SamplerService.class);
}
public ScreenCaptureService screenCapture() {
return get(ScreenCaptureService.class);
}
public StatisticsService statistics() {
return get(StatisticsService.class);
}
public ThresholdService threshold() {
return get(ThresholdService.class);
}
public UIService ui() {
return get(UIService.class);
}
public UpdateService update() {
return get(UpdateService.class);
}
public UploaderService uploader() {
return get(UploaderService.class);
}
public WindowService window() {
return get(WindowService.class);
}
}