edu.stanford.epad.epadws.processing.pipeline.task.SingleFrameDICOMPngGeneratorTask.java Source code

Java tutorial

Introduction

Here is the source code for edu.stanford.epad.epadws.processing.pipeline.task.SingleFrameDICOMPngGeneratorTask.java

Source

/*******************************************************************************
 * Copyright (c) 2015 The Board of Trustees of the Leland Stanford Junior University
 * BY CLICKING ON "ACCEPT," DOWNLOADING, OR OTHERWISE USING EPAD, YOU AGREE TO THE FOLLOWING TERMS AND CONDITIONS:
 * STANFORD ACADEMIC SOFTWARE SOURCE CODE LICENSE FOR
 * "ePAD Annotation Platform for Radiology Images"
 *
 * This Agreement covers contributions to and downloads from the ePAD project ("ePAD") maintained by The Board of Trustees 
 * of the Leland Stanford Junior University ("Stanford"). 
 *
 * *   Part A applies to downloads of ePAD source code and/or data from ePAD. 
 *
 * *   Part B applies to contributions of software and/or data to ePAD (including making revisions of or additions to code 
 * and/or data already in ePAD), which may include source or object code. 
 *
 * Your download, copying, modifying, displaying, distributing or use of any ePAD software and/or data from ePAD 
 * (collectively, the "Software") is subject to Part A. Your contribution of software and/or data to ePAD (including any 
 * that occurred prior to the first publication of this Agreement) is a "Contribution" subject to Part B. Both Parts A and 
 * B shall be governed by and construed in accordance with the laws of the State of California without regard to principles 
 * of conflicts of law. Any legal action involving this Agreement or the Research Program will be adjudicated in the State 
 * of California. This Agreement shall supersede and replace any license terms that you may have agreed to previously with 
 * respect to ePAD.
 *
 * PART A. DOWNLOADING AGREEMENT - LICENSE FROM STANFORD WITH RIGHT TO SUBLICENSE ("SOFTWARE LICENSE").
 * 1. As used in this Software License, "you" means the individual downloading and/or using, reproducing, modifying, 
 * displaying and/or distributing Software and the institution or entity which employs or is otherwise affiliated with you. 
 * Stanford  hereby grants you, with right to sublicense, with respect to Stanford's rights in the Software, a 
 * royalty-free, non-exclusive license to use, reproduce, make derivative works of, display and distribute the Software, 
 * provided that: (a) you adhere to all of the terms and conditions of this Software License; (b) in connection with any 
 * copy, distribution of, or sublicense of all or any portion of the Software, the terms and conditions in this Software 
 * License shall appear in and shall apply to such copy and such sublicense, including without limitation all source and 
 * executable forms and on any user documentation, prefaced with the following words: "All or portions of this licensed 
 * product  have been obtained under license from The Board of Trustees of the Leland Stanford Junior University. and are 
 * subject to the following terms and conditions" AND any user interface to the Software or the "About" information display 
 * in the Software will display the following: "Powered by ePAD http://epad.stanford.edu;" (c) you preserve and maintain 
 * all applicable attributions, copyright notices and licenses included in or applicable to the Software; (d) modified 
 * versions of the Software must be clearly identified and marked as such, and must not be misrepresented as being the 
 * original Software; and (e) you consider making, but are under no obligation to make, the source code of any of your 
 * modifications to the Software freely available to others on an open source basis.
 *
 * 2. The license granted in this Software License includes without limitation the right to (i) incorporate the Software 
 * into your proprietary programs (subject to any restrictions applicable to such programs), (ii) add your own copyright 
 * statement to your modifications of the Software, and (iii) provide additional or different license terms and conditions 
 * in your sublicenses of modifications of the Software; provided that in each case your use, reproduction or distribution 
 * of such modifications otherwise complies with the conditions stated in this Software License.
 * 3. This Software License does not grant any rights with respect to third party software, except those rights that 
 * Stanford has been authorized by a third party to grant to you, and accordingly you are solely responsible for (i) 
 * obtaining any permissions from third parties that you need to use, reproduce, make derivative works of, display and 
 * distribute the Software, and (ii) informing your sublicensees, including without limitation your end-users, of their 
 * obligations to secure any such required permissions.
 * 4. You agree that you will use the Software in compliance with all applicable laws, policies and regulations including, 
 * but not limited to, those applicable to Personal Health Information ("PHI") and subject to the Institutional Review 
 * Board requirements of the your institution, if applicable. Licensee acknowledges and agrees that the Software is not 
 * FDA-approved, is intended only for research, and may not be used for clinical treatment purposes. Any commercialization 
 * of the Software is at the sole risk of you and the party or parties engaged in such commercialization. You further agree 
 * to use, reproduce, make derivative works of, display and distribute the Software in compliance with all applicable 
 * governmental laws, regulations and orders, including without limitation those relating to export and import control.
 * 5. You or your institution, as applicable, will indemnify, hold harmless, and defend Stanford against any third party 
 * claim of any kind made against Stanford arising out of or related to the exercise of any rights granted under this 
 * Agreement, the provision of Software, or the breach of this Agreement. Stanford provides the Software AS IS and WITH ALL 
 * FAULTS.  Stanford makes no representations and extends no warranties of any kind, either express or implied.  Among 
 * other things, Stanford disclaims any express or implied warranty in the Software:
 * (a)  of merchantability, of fitness for a particular purpose,
 * (b)  of non-infringement or 
 * (c)  arising out of any course of dealing.
 *
 * Title and copyright to the Program and any associated documentation shall at all times remain with Stanford, and 
 * Licensee agrees to preserve same. Stanford reserves the right to license the Program at any time for a fee.
 * 6. None of the names, logos or trademarks of Stanford or any of Stanford's affiliates or any of the Contributors, or any 
 * funding agency, may be used to endorse or promote products produced in whole or in part by operation of the Software or 
 * derived from or based on the Software without specific prior written permission from the applicable party.
 * 7. Any use, reproduction or distribution of the Software which is not in accordance with this Software License shall 
 * automatically revoke all rights granted to you under this Software License and render Paragraphs 1 and 2 of this 
 * Software License null and void.
 * 8. This Software License does not grant any rights in or to any intellectual property owned by Stanford or any 
 * Contributor except those rights expressly granted hereunder.
 *
 * PART B. CONTRIBUTION AGREEMENT - LICENSE TO STANFORD WITH RIGHT TO SUBLICENSE ("CONTRIBUTION AGREEMENT").
 * 1. As used in this Contribution Agreement, "you" means an individual providing a Contribution to ePAD and the 
 * institution or entity which employs or is otherwise affiliated with you.
 * 2. This Contribution Agreement applies to all Contributions made to ePAD at any time. By making a Contribution you 
 * represent that: (i) you are legally authorized and entitled by ownership or license to make such Contribution and to 
 * grant all licenses granted in this Contribution Agreement with respect to such Contribution; (ii) if your Contribution 
 * includes any patient data, all such data is de-identified in accordance with U.S. confidentiality and security laws and 
 * requirements, including but not limited to the Health Insurance Portability and Accountability Act (HIPAA) and its 
 * regulations, and your disclosure of such data for the purposes contemplated by this Agreement is properly authorized and 
 * in compliance with all applicable laws and regulations; and (iii) you have preserved in the Contribution all applicable 
 * attributions, copyright notices and licenses for any third party software or data included in the Contribution.
 * 3. Except for the licenses you grant in this Agreement, you reserve all right, title and interest in your Contribution.
 * 4. You hereby grant to Stanford, with the right to sublicense, a perpetual, worldwide, non-exclusive, no charge, 
 * royalty-free, irrevocable license to use, reproduce, make derivative works of, display and distribute the Contribution. 
 * If your Contribution is protected by patent, you hereby grant to Stanford, with the right to sublicense, a perpetual, 
 * worldwide, non-exclusive, no-charge, royalty-free, irrevocable license under your interest in patent rights embodied in 
 * the Contribution, to make, have made, use, sell and otherwise transfer your Contribution, alone or in combination with 
 * ePAD or otherwise.
 * 5. You acknowledge and agree that Stanford ham may incorporate your Contribution into ePAD and may make your 
 * Contribution as incorporated available to members of the public on an open source basis under terms substantially in 
 * accordance with the Software License set forth in Part A of this Agreement. You further acknowledge and agree that 
 * Stanford shall have no liability arising in connection with claims resulting from your breach of any of the terms of 
 * this Agreement.
 * 6. YOU WARRANT THAT TO THE BEST OF YOUR KNOWLEDGE YOUR CONTRIBUTION DOES NOT CONTAIN ANY CODE OBTAINED BY YOU UNDER AN 
 * OPEN SOURCE LICENSE THAT REQUIRES OR PRESCRIBES DISTRBUTION OF DERIVATIVE WORKS UNDER SUCH OPEN SOURCE LICENSE. (By way 
 * of non-limiting example, you will not contribute any code obtained by you under the GNU General Public License or other 
 * so-called "reciprocal" license.)
 *******************************************************************************/
package edu.stanford.epad.epadws.processing.pipeline.task;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import javax.imageio.ImageIO;

import org.apache.commons.io.IOUtils;

import edu.stanford.epad.common.dicom.DICOMFileDescription;
import edu.stanford.epad.common.dicom.DicomReader;
import edu.stanford.epad.common.util.EPADConfig;
import edu.stanford.epad.common.util.EPADFileUtils;
import edu.stanford.epad.common.util.EPADLogger;
import edu.stanford.epad.common.util.EventMessageCodes;
import edu.stanford.epad.dtos.PNGFileProcessingStatus;
import edu.stanford.epad.dtos.SeriesProcessingStatus;
import edu.stanford.epad.dtos.TaskStatus;
import edu.stanford.epad.epadws.dcm4chee.Dcm4CheeDatabaseUtils;
import edu.stanford.epad.epadws.epaddb.EpadDatabase;
import edu.stanford.epad.epadws.epaddb.EpadDatabaseOperations;
import edu.stanford.epad.epadws.service.DefaultEpadProjectOperations;
import edu.stanford.epad.epadws.service.EpadProjectOperations;
import edu.stanford.epad.epadws.service.UserProjectService;

public class SingleFrameDICOMPngGeneratorTask implements GeneratorTask {
    private static final EPADLogger log = EPADLogger.getInstance();

    private final String patientName;
    private final String studyUID;
    private final String seriesUID;
    private final String imageUID;
    private final int instanceNumber;
    private final File dicomFile;
    private final File pngFile;

    static public Set imagesBeingProcessed = Collections.synchronizedSet(new HashSet());

    public SingleFrameDICOMPngGeneratorTask(String patientName, DICOMFileDescription dicomFileDescription,
            File dicomFile, File pngFile) {
        this.patientName = patientName;
        this.studyUID = dicomFileDescription.studyUID;
        this.seriesUID = dicomFileDescription.seriesUID;
        this.imageUID = dicomFileDescription.imageUID;
        this.instanceNumber = dicomFileDescription.instanceNumber;
        this.dicomFile = dicomFile;
        this.pngFile = pngFile;
    }

    @Override
    public String getSeriesUID() {
        return this.seriesUID;
    }

    @Override
    public void run() {
        Thread.currentThread().setPriority(Thread.MIN_PRIORITY); // Let interactive thread run sooner
        if (imagesBeingProcessed.contains(imageUID)) {
            log.info("Image " + imageUID + " already being processed");
            return;
        }
        generatePNGs();
    }

    private void generatePNGs() {
        EpadDatabaseOperations epadDatabaseOperations = EpadDatabase.getInstance().getEPADDatabaseOperations();
        EpadProjectOperations projectOperations = DefaultEpadProjectOperations.getInstance();
        File inputDICOMFile = dicomFile;
        File outputPNGFile = pngFile;
        Map<String, String> epadFilesRow = new HashMap<String, String>();
        OutputStream outputPNGStream = null;
        String pngPath = pngFile.getAbsolutePath();
        try {
            imagesBeingProcessed.add(imageUID);
            String username = null;
            String projectID = EPADConfig.xnatUploadProjectID;
            if (UserProjectService.pendingUploads.containsKey(studyUID)) {
                username = UserProjectService.pendingUploads.get(studyUID);
                if (username != null && username.indexOf(":") != -1) {
                    projectID = username.substring(username.indexOf(":") + 1);
                    username = username.substring(0, username.indexOf(":"));
                }
                if (username != null) {
                    epadDatabaseOperations.insertEpadEvent(username, EventMessageCodes.STUDY_PROCESSED, "", "", "",
                            patientName, "", "", "Study:" + studyUID, projectID, "", "", "", false);
                    UserProjectService.pendingUploads.remove(studyUID);
                }
            }
            projectOperations.updateUserTaskStatus(username, TaskStatus.TASK_DICOM_PNG_GEN, seriesUID,
                    "Generating PNGs, instance:" + instanceNumber, null, null);
            DicomReader instance = new DicomReader(inputDICOMFile);
            String pngFilePath = outputPNGFile.getAbsolutePath();
            outputPNGFile = new File(pngFilePath);

            EPADFileUtils.createDirsAndFile(outputPNGFile);
            try {
                outputPNGStream = new FileOutputStream(outputPNGFile);
                ImageIO.write(instance.getPackedImage(), "png", outputPNGStream);
                outputPNGStream.close();
            } catch (Exception x) {
                // Try second method using pixelmed library
                log.warning("dcm4che failed to create PNG for instance " + instanceNumber + " in series "
                        + seriesUID + " for patient " + patientName + ", trying pixelmed", x);
                outputPNGFile.delete();
                instance.dcmconvpng3(0, outputPNGFile);
            }
            epadFilesRow = Dcm4CheeDatabaseUtils.createEPadFilesRowData(outputPNGFile.getAbsolutePath(),
                    outputPNGFile.length(), imageUID);
            log.info("PNG of size " + getFileSize(epadFilesRow) + " generated for instance " + instanceNumber
                    + " in series " + seriesUID + ", study " + studyUID + " for patient " + patientName);

            epadDatabaseOperations.updateEpadFileRow(epadFilesRow.get("file_path"), PNGFileProcessingStatus.DONE,
                    getFileSize(epadFilesRow), "");
        } catch (FileNotFoundException e) {
            log.warning("Failed to create PNG for instance " + instanceNumber + " in series " + seriesUID
                    + " for patient " + patientName, e);
            //use outputPNGFile.getAbsolutePath() instead of epadFilesRow.get("file_path"). returns null if exception occured before createEPadFilesRowData
            epadDatabaseOperations.updateEpadFileRow(pngPath, PNGFileProcessingStatus.ERROR, 0,
                    "DICOM file not found.");
            epadDatabaseOperations.updateOrInsertSeries(seriesUID, SeriesProcessingStatus.ERROR);
        } catch (IOException e) {
            log.warning("Failed to create PNG for instance " + instanceNumber + " in series " + seriesUID
                    + " for patient " + patientName, e);
            epadDatabaseOperations.updateEpadFileRow(pngPath, PNGFileProcessingStatus.ERROR, 0,
                    "IO Error: " + e.getMessage());
            epadDatabaseOperations.updateOrInsertSeries(seriesUID, SeriesProcessingStatus.ERROR);
        } catch (Throwable t) {
            log.warning("Failed to create PNG for instance " + instanceNumber + " in series " + seriesUID
                    + " for patient " + patientName, t);
            epadDatabaseOperations.updateEpadFileRow(pngPath, PNGFileProcessingStatus.ERROR, 0,
                    "General Exception: " + t.getMessage());
            epadDatabaseOperations.updateOrInsertSeries(seriesUID, SeriesProcessingStatus.ERROR);
        } finally {
            imagesBeingProcessed.remove(imageUID);
            IOUtils.closeQuietly(outputPNGStream);
            if (inputDICOMFile.getName().endsWith(".tmp")) {
                inputDICOMFile.delete();
            }
        }
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("PngGeneratorTask[").append(" in=").append(dicomFile);
        sb.append(" out=").append(pngFile).append("]");

        return sb.toString();
    }

    @Override
    public File getDICOMFile() {
        return dicomFile;
    }

    @Override
    public String getTagFilePath() {
        return pngFile.getAbsolutePath().replaceAll("\\.png", ".tag");
    }

    @Override
    public String getTaskType() {
        return "Png";
    }

    private int getFileSize(Map<String, String> epadFilesTable) {
        try {
            String fileSize = epadFilesTable.get("file_size");
            return Integer.parseInt(fileSize);
        } catch (Exception e) {
            log.warning("Warning: failed to get file", e);
            return 0;
        }
    }
}