Class FitsFile

Namespace

FitsModel

Assembly

FitsModel.dll

A simple collection of FitsHdu objects.

public class FitsFile : List<FitsHdu>, IList<FitsHdu>, ICollection<FitsHdu>, IList, ICollection, IReadOnlyList<FitsHdu>, IReadOnlyCollection<FitsHdu>, IEnumerable<FitsHdu>, IEnumerable

Inheritance

object

List<FitsHdu>

FitsFile

Implements

IList<FitsHdu>

ICollection<FitsHdu>

IList

ICollection

IReadOnlyList<FitsHdu>

IReadOnlyCollection<FitsHdu>

IEnumerable<FitsHdu>

IEnumerable

Inherited Members

List<FitsHdu>.Add(FitsHdu)

List<FitsHdu>.AddRange(IEnumerable<FitsHdu>)

List<FitsHdu>.AsReadOnly()

List<FitsHdu>.BinarySearch(int, int, FitsHdu, IComparer<FitsHdu>)

List<FitsHdu>.BinarySearch(FitsHdu)

List<FitsHdu>.BinarySearch(FitsHdu, IComparer<FitsHdu>)

List<FitsHdu>.Clear()

List<FitsHdu>.Contains(FitsHdu)

List<FitsHdu>.ConvertAll<TOutput>(Converter<FitsHdu, TOutput>)

List<FitsHdu>.CopyTo(FitsHdu[])

List<FitsHdu>.CopyTo(int, FitsHdu[], int, int)

List<FitsHdu>.CopyTo(FitsHdu[], int)

List<FitsHdu>.EnsureCapacity(int)

List<FitsHdu>.Exists(Predicate<FitsHdu>)

List<FitsHdu>.Find(Predicate<FitsHdu>)

List<FitsHdu>.FindAll(Predicate<FitsHdu>)

List<FitsHdu>.FindIndex(Predicate<FitsHdu>)

List<FitsHdu>.FindIndex(int, Predicate<FitsHdu>)

List<FitsHdu>.FindIndex(int, int, Predicate<FitsHdu>)

List<FitsHdu>.FindLast(Predicate<FitsHdu>)

List<FitsHdu>.FindLastIndex(Predicate<FitsHdu>)

List<FitsHdu>.FindLastIndex(int, Predicate<FitsHdu>)

List<FitsHdu>.FindLastIndex(int, int, Predicate<FitsHdu>)

List<FitsHdu>.ForEach(Action<FitsHdu>)

List<FitsHdu>.GetEnumerator()

List<FitsHdu>.GetRange(int, int)

List<FitsHdu>.Slice(int, int)

List<FitsHdu>.IndexOf(FitsHdu)

List<FitsHdu>.IndexOf(FitsHdu, int)

List<FitsHdu>.IndexOf(FitsHdu, int, int)

List<FitsHdu>.Insert(int, FitsHdu)

List<FitsHdu>.InsertRange(int, IEnumerable<FitsHdu>)

List<FitsHdu>.LastIndexOf(FitsHdu)

List<FitsHdu>.LastIndexOf(FitsHdu, int)

List<FitsHdu>.LastIndexOf(FitsHdu, int, int)

List<FitsHdu>.Remove(FitsHdu)

List<FitsHdu>.RemoveAll(Predicate<FitsHdu>)

List<FitsHdu>.RemoveAt(int)

List<FitsHdu>.RemoveRange(int, int)

List<FitsHdu>.Reverse()

List<FitsHdu>.Reverse(int, int)

List<FitsHdu>.Sort()

List<FitsHdu>.Sort(IComparer<FitsHdu>)

List<FitsHdu>.Sort(int, int, IComparer<FitsHdu>)

List<FitsHdu>.Sort(Comparison<FitsHdu>)

List<FitsHdu>.ToArray()

List<FitsHdu>.TrimExcess()

List<FitsHdu>.TrueForAll(Predicate<FitsHdu>)

List<FitsHdu>.Capacity

List<FitsHdu>.Count

List<FitsHdu>.this[int]

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

FitsFile()

Creates a new FitsFile with a single primary FitsHdu.

public FitsFile()

FitsFile(FitsHdu)

Creates a new FitsFile with the specified primary FitsHdu.

public FitsFile(FitsHdu hdu)

Parameters

hdu FitsHdu

FitsFile(List<FitsHdu>)

Creates a new FitsFile with the specified HDUs.

public FitsFile(List<FitsHdu> hdus)

Parameters

hdus List<FitsHdu>

Exceptions

FitsModelException

Thrown if no HDUs are provided or the primary and extension HDUs are not valid.

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetFirstImageHdu()

Gets and validates the first image HDU in this file if it exists.

public FitsHdu? GetFirstImageHdu()

Returns

FitsHdu

The first image in this file. null otherwise.

GetHashCode()

public override int GetHashCode()

Returns

int

GetPrimaryHdu()

Gets and validates this file's primary HDU if it exists.

public FitsHdu? GetPrimaryHdu()

Returns

FitsHdu

The primary HDU for this file. null otherwise

ToString()

String representation of the number of FitsHdus in this file.

public override string ToString()

Returns

string

ValidateFile()

Val

public void ValidateFile()

Exceptions

FitsModelException

WriteToStream(FitsDataBlockStream)

Writes the contents of this FITS file to a FitsDataBlockStream and uses its cancellation token to stop writing if needed.

public Task WriteToStream(FitsDataBlockStream dataBlockStream)

Parameters

dataBlockStream FitsDataBlockStream

Returns

Task

WriteToStream(Stream)

Writes this FITS File to a stream.

public Task WriteToStream(Stream stream)

Parameters

stream Stream

Returns

Task

WriteToStream(Stream, CancellationToken)

Writes the contents of this FITS file to a stream until the cancellation token is triggered.

public Task WriteToStream(Stream stream, CancellationToken cancellationToken)

Parameters

stream Stream

The stream to write to.

cancellationToken CancellationToken

Use this to indicate when we can finish writing to the stream.

Returns

Task