~andreas.hoelzl/jhelioviewer/jhv-formatting

« back to all changes in this revision

Viewing changes to viewmodel/src/org/helioviewer/viewmodel/metadata/OcculterMetaData.java

  • Committer: Andreas Hoelzl
  • Date: 2010-03-23 19:37:12 UTC
  • Revision ID: andreas_hoelzl_23@hotmail.com-20100323193712-wgx872c3tpo3y729
formattingĀ changed

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
package org.helioviewer.viewmodel.metadata;
2
2
 
3
 
/** Meta data providing informations about the occulter used to take the picture.
 
3
/**
 
4
 * Meta data providing informations about the occulter used to take the picture.
4
5
 * 
5
 
 * <p>Some solar images are taken using an occulter, to shield the sun
6
 
 * itself. That kind of images appear to have a black disc in the center
7
 
 * of the image. This interface provides informations about the size of
8
 
 * the occulter in physical coordinates, so they can be easily compared
9
 
 * to the region information.
 
6
 * <p>
 
7
 * Some solar images are taken using an occulter, to shield the sun itself. That
 
8
 * kind of images appear to have a black disc in the center of the image. This
 
9
 * interface provides informations about the size of the occulter in physical
 
10
 * coordinates, so they can be easily compared to the region information.
10
11
 * 
11
12
 * @author Markus Langenberg
12
 
 *
 
13
 * 
13
14
 */
14
15
public interface OcculterMetaData {
15
16
 
16
 
        /** Returns the physical inner radius of the occulter.
17
 
         * 
18
 
         * @return Physical inner radius of the occulter
19
 
         */
20
 
        public double getInnerPhysicalOcculterRadius();
21
 
        
22
 
        /** Returns the physical outer radius of the occulter.
23
 
         * 
24
 
         * @return Physical outer radius of the occulter
25
 
         */
26
 
        public double getOuterPhysicalOcculterRadius();
 
17
    /**
 
18
     * Returns the physical inner radius of the occulter.
 
19
     * 
 
20
     * @return Physical inner radius of the occulter
 
21
     */
 
22
    public double getInnerPhysicalOcculterRadius();
 
23
 
 
24
    /**
 
25
     * Returns the physical outer radius of the occulter.
 
26
     * 
 
27
     * @return Physical outer radius of the occulter
 
28
     */
 
29
    public double getOuterPhysicalOcculterRadius();
27
30
}