AbstractFieldOfView.java

  1. /* Copyright 2002-2021 CS GROUP
  2.  * Licensed to CS GROUP (CS) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * CS licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *   http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.orekit.geometry.fov;

  18. /** Abstract class representing a spacecraft sensor Field Of View.
  19.  * @author Luc Maisonobe
  20.  * @since 10.1
  21.  */
  22. public abstract class AbstractFieldOfView implements FieldOfView {

  23.     /** Margin to apply to the zone. */
  24.     private final double margin;

  25.     /** Build a new instance.
  26.      * @param margin angular margin to apply to the zone (if positive,
  27.      * points outside of the raw FoV but close enough to the boundary are
  28.      * considered visible; if negative, points inside of the raw FoV
  29.      * but close enough to the boundary are considered not visible)
  30.      */
  31.     protected AbstractFieldOfView(final double margin) {
  32.         this.margin = margin;
  33.     }

  34.     /** {@inheritDoc} */
  35.     @Override
  36.     public double getMargin() {
  37.         return margin;
  38.     }

  39. }