[fitsbits] Definition of "deprecated"

[William Pence]

As I recall, the definition of "deprecate" was carefully crafted to 
satisfy the radio interferometry community.  The reason for deprecating 
random groups was to prevent their use from spreading beyond their 
current use with radio interferometry data files; other types of data 
should not be distributed in the random groups format, and instead 
should use the more modern binary table structure. The decision to 
deprecate random groups was not intended to force the radio 
interferometry community to give up using random groups and rewrite all 
their software to use binary tables instead.

I think a similar argument can be made for deprecating CROTA.  There are 
a huge number of existing instruments that continue to produce data 
files containing this keyword, so it is not realistic to expect that 
they all be modified to use the newer rotation matrix keywords.  I think 
we can "strongly discourage" entirely new intruments and software 
systems from relying on the old CROTA keyword, but it would go too far 
to disparage any continued use of CROTA as being "bad form".

Bill Pence


Dick Shaw wrote: (27-8-2007)
> The current version (v2.1b) of the Standard defines "deprecated" as:
> 
> "This term is used to refer to obsolete structures that should not be used for 
> new applications but remain valid."
> 
> The proposed 3.0 revision is a little more wordy:
> 
> "This term is used to refer to obsolete structures that _should not_ be used 
> for new applications but _shall_ remain valid for use by applications that 
> already use the deprecated structure."
> 
> It is perhaps a little confusing to refer to "applications" in this context, 
> when the standard governs data files and their interpretation, but only 
> advises the functionality of applicable software. The following wording is an 
> attempt to clarify the definition:
> 
> "This term refers to obsolete features or structures in FITS that _should not_ 
> be used in new FITS files, but _shall_ remain valid indefinitely. FITS users 
> and data engineers should be aware that the use of deprecated structures is 
> considered bad form and should be avoided."
> 
> The above wording would, I think, send a message to FITS software developers 
> that they should update their applications and libraries to make use of 
> alternative structures as soon as possible--e.g., I think we really do want 
> users to stop using CROTAi and EPOCH, and FITS writing software should help 
> them do that. A potential ambiguity is: what does this mean for new FITS files 
> that are modified by some application--would the application be obligated to 
> update the FITS file to expunge deprecated features? My view is that 
> application developers might be encouraged to provide an update path if the 
> modification in question is related to the obsolete features, but not 
> otherwise. For example, if the purpose of the update is to modify the WCS, 
> then one could argue that CROTAi etc. ought to be replaced with a modern WCS 
> expression.
> 
> For reference, here a list of all the FITS features that have been deprecated:
> 
> - BLOCKED keyword
> - EPOCH keyword
> - random groups
> - CROTAi keyword
> 
> Additional structures or features that v3.0 would deprecate:
> - special records
> - implicit decimal points in ASCII table fields (actually, the v3.0 draft says 
> this should be outright banned)
-- 
____________________________________________________________________
Dr. William Pence                       pence at milkyway.gsfc.nasa.gov
NASA/GSFC Code 662       HEASARC        +1-301-286-4599 (voice)
Greenbelt MD 20771                      +1-301-286-1684 (fax)