Installation

Include in project

Usage

Initialization

Initialize the neuropacs™ API.


  import com.neuropacs.Neuropacs

  // Define neuropacs parameters
  String apiKey = "your_api_key"; // API key
  String serverUrl = "server_url"; // neuropacs™ serverl URL
  String productName = "Atypical/MSAp/PSP-v1.0"; // Desired neuropacs™ product
  String predictionFormat = "JSON"; // Output format of order results ("TXT"/"JSON"/"XML"/"FEATURES")
  String qcForamt = "CSV"; // Output format of QC results ("CSV"/"TXT"/"JSON")
  String originType = "my_application"; // Requestor origin

  // Initialize the API
  Neuropacs npcs = new Neuropacs(serverUrl, apiKey, originType);

Example

Working example using the neuropacs™ API.


  // Create a session
  String conn = npcs.connect();

  // Create a new order
  String conn = npcs.newJob();

  // Upload a dataset from path
  boolean upload = npcs.uploadDatasetFromPath(
    orderId, 
    "/path/to/dataset", 
    System.out::println // optional progress callback
  );

  // Run QC/Compliance check on uploaded dataset (not required)
  String qcResults = npcs.qcCheck(orderId, qcFormat);

  // Start an order
  String orderStart = npcs.runJob(orderId, productName);

  // Check order status
  String status = npcs.checkStatus(orderId);

  // Retrieve job results
  String results = npcs.getResults(orderId, predictionFormat);

  // Retrieve job results in PNG
  byte[] resultsPng = npcs.getResultsPng(orderId);

Example viewing a PNG result

Download a PNG result file and view it.


  // Import required packages
  import javax.imageio.ImageIO;
  import java.awt.image.BufferedImage;
  import java.io.ByteArrayInpudtStream;
  import java.io.File;

  // Retrieve job results in PNG
  byte[] resultsPng = npcs.getResultsPng(orderId);

  // Convert byte[] to an InputStream
  ByteArrayInputStream bais = new ByteArrayInputStream(resultsPng);

  // Read the input stream into a BufferedImage
  BufferedImage image = ImageIO.read(bais);

  // Save the image to a file
  ImageIO.write(image, "png", new File("neuropacs_report.png"));

API Key Usage Report

Generate a structured API key usage report for any neuropacs™ API key. If an admin API key is used. An aggregated report will be created with all keys associated with the same institution. If "email" format is used, an email will be sent to the admin associated with the specified API key. 


  // Define neuropacs parameters
  String apiKey = "your_api_key"; // API key
  String serverUrl = "server_url"; // neuropacs™ serverl URL
  String originType = "my_application"; // Requestor origin
  String format = "JSON"; // Format of report ("TXT"/"JSON"/"EMAIL")
  String startDate = "10/1/2025"; // Start date of report (mM/dD/YYYY)
  String endDate = "12/15/2025"; // End date of report (mM/dD/YYYY)

  // Initialize the API
  Neuropacs npcs = new Neuropacs(serverUrl, apiKey, originType);

  // Create a session
  String conn = npcs.connect();

  // Generate the report
  String report = npcs.getReport(format, startDate, endDate);

DICOMweb Integration

The API retrieves and processes images directly from DICOMweb WADO-RS servers, enabling neuropacs™ analysis for streamlined diagnostic workflows. 


  // Define DICOMweb parameters
  String wadoUrl = "http://localhost:8080/dcm4chee-arc/aets/DCM4CHEE/rs";
  String studyUid = "1.3.12.2.1107.5.2.32.35162.30000022041820573832300000043";
  String username = "username"; // If not required, use null
  String password = "password"; // If not required, use null

  // Upload a dataset from DICOMweb
  boolean upload = await npcs.uploadDatasetFromDicomWeb(
    orderId,
    wadoUrl,
    studyUid,
    username,  
    password, 
    System.out::println // optional progress callback
  );

Contact

Kerrick Cavanaugh (Lead Software Engineer) - kerrick@neuropacs.com

License

This project is licensed under the MIT.

Explore

Integrations

Explore the different systems and software that our product integrates with. Click each integration for detailed setup and usage instructions.

Supported Programming Languages

Our product supports various programming languages to offer flexibility in development. Click each language for APIs, libraries, and examples.