JiscMail Logo
Email discussion lists for the UK Education and Research communities

Help for CCP4BB Archives


CCP4BB Archives

CCP4BB Archives


CCP4BB@JISCMAIL.AC.UK


View:

Message:

[

First

|

Previous

|

Next

|

Last

]

By Topic:

[

First

|

Previous

|

Next

|

Last

]

By Author:

[

First

|

Previous

|

Next

|

Last

]

Font:

Proportional Font

LISTSERV Archives

LISTSERV Archives

CCP4BB Home

CCP4BB Home

CCP4BB  September 2013

CCP4BB September 2013

Options

Subscribe or Unsubscribe

Subscribe or Unsubscribe

Log In

Log In

Get Password

Get Password

Subject:

Re: Code to handle the syntax of (mm)CIF data correctly.

From:

Phil Evans <[log in to unmask]>

Reply-To:

Phil Evans <[log in to unmask]>

Date:

Thu, 19 Sep 2013 10:45:04 +0100

Content-Type:

text/plain

Parts/Attachments:

Parts/Attachments

text/plain (101 lines)

Do you really want to read the whole of a long reflection loop into memory rather than parsing it one line at a time (which should be possible once you have worked out what is in the file)? That would end up with storing the reflection list twice, the memory copy of the input file and the internal representation for the program. I do get complaints from people trying to run e.g. Pointless with large datasets on 32-bit machines, crashing because it runs out of memory

If you imagine someone corresponding to the XDS INTEGRATE.HKL file with 120 characters/reflection, then a dataset with 10^7 reflections (not outrageously large these days) occupies 1.2e9 bytes, over 1GB, which seems a lot to add gratuitously to memory demands even on today's computers 

Of course (in my opinion) a working format (as opposed to an archive format) should be binary for size, accuracy (FP dynamic range) and speed. 
A quick comparison (using Pointless)

Read 5.3e6 reflections from a formatted XDS INTEGRATE.HKL file, 608MB, 15 secs
Read equivalent binary MTZ file, 262MB, 2.6 secs

Phil

On 18 Sep 2013, at 15:58, yayahjb <[log in to unmask]> wrote:

> Dear Colleagues,
> 
>  There are two major issues that tend to trip up CIF programmers:
> 
>   1.  Dealing with the order independence of CIF.  Unlike PDB format, tags in CIF can validly
> be presented in any order.  This means you cannot simply scan a CIF for a tag you want and
> start processing from that point forward as you do with a PDB file.  In general to read
> a CIF properly, you need to read all of it into memory before you can do anything with it.
> A common mistake is to assume that just because many CIFs have been written with tags in
> a given order, the next CIF you encounter will also have the tags in that order.
> 
>  2.  Doing the lexical scan (the tokenizing) correctly.  CIF uses a context sensitive grammar,
> so lexers based on simple BNF tend to make mistakes, and most reliable CIF lexers are
> hand-written rather than being generated from a grammar.  The advice to use a pre-written
> and tested lexer is sensible.
> 
> The bottom line is that, while it is relatively easy to write a valid CIF, reading CIFs reliably
> can be a very challenging programming task, because you need to write code that will handle
> the very complex general case, rather than just specific examples.  Fortunately there are
> software packages to help you do this.
> 
>  Herbert J. Bernstein
> 
> On 9/18/13 10:41 AM, Peter Keller wrote:
>> Hi Phil,
>> 
>> I agree that the issue that you raise (about the need to define the data items and categories propery) is an important one that needs proper consideration. However, your mail could be read to suggest that correct parsing of CIF-format data is a secondary issue that doesn't deserve the same attention from developers.
>> 
>> I hope that this isn't quite what you meant....  There are already mutually-incompatible CIF dialects out there that have been created by developers coding to their own understanding and interpretations of the CIF/STAR format. I am sure that you would not want to be the creator of yet another one :-) Correct tokenising is a necessary (but not sufficient) condition for preventing the problem getting worse.
>> 
>> In practice, the code and applications that I have seen, and the discussions about this that I have had, all suggest that developers find it more difficult to write code that tokenises CIF/STAR-format data correctly than code that handles other text formats that they have to deal with in this field. My experience suggests that this is an important practical issue with real-world ramifications, and it is worthwhile devoting some effort to it.
>> 
>> Regards,
>> Peter.
>> 
>> On Wed, 18 Sep 2013, Phil Evans wrote:
>> 
>>> Date: Wed, 18 Sep 2013 13:38:07 +0100
>>> From: Phil Evans <[log in to unmask]>
>>> To: [log in to unmask]
>>> Subject: Re: [ccp4bb] Code to handle the syntax of (mm)CIF data correctly.
>>> 
>>> As a novice looking at mmCIF from a developers point of view, for reflection data, the complication is not so much tokenising (parsing), but what items to write or to expect to read. For example as far as I can see an observed intensity may be encoded in a reflection loop (merged or unmerged) as any one of the following, and there seem to be similar choices for other items:-
>>> 
>>> 
>>> _refln_intensity_meas
>>> _refln.F_squared_meas
>>> _refln.pdbx_I_plus, _refln.pdbx_I_minus
>>> 
>>> _diffrn_refln.counts_net
>>> _diffrn_refln.intensity_net
>>> 
>>> If I'm writing a file, which should I use, and if I'm reading one which ones should I expect? And is there a distinction between merged and unmerged data?
>>> 
>>> confused (easily)
>>> Phil
>>> 
>>> 
>>> 
>>> On 17 Sep 2013, at 15:30, Peter Keller <[log in to unmask]> wrote:
>>> 
>>>> Dear all,
>>>> 
>>>> At Global Phasing, we have seen that there are still issues with the way that different applications deal with mmCIF-format data, and this continues to cause problems for users. I believe that part of the reason for this is that the underlying syntax (the STAR format) is not universally understood, and that a common and complete understanding of the full STAR syntax amongst programmers who deal with the format will help with some of the existing problems.
>>>> 
>>>> I wrote some code for low-level handling of the STAR format a while ago that I have been meaning to release for over a year. Garry Battle's announcement on 23 August about the mmCIF/PDBx workshop at the EBI has prompted me into action: I have written a short article that discusses some examples of the issues that we have encountered, and made my code available for download. The references in the article are given primarily as web links: more conventional citations can usually be found in the pages that I link to. This code has not been used in any released products, but it has had some internal use at Global Phasing. There is an MX bias in the article's discussion, but the issues are not restricted to MX.
>>>> 
>>>> As I explain in the article, the handling of the input data is based on an enourmous regular expression that matches STAR data, with only a little logic in the code itself. The regular expression should be usable with a variety of other languages, not only in Java (which I have used in this case). The code, or the regular expression on its own, may be freely used in other projects: see the included licencing for details, but basically you should: (i) give credit for using it, and (ii) if you choose to modify the regular expression, state that you have done so in that credit.
>>>> 
>>>> The article, which contains links to a tar file containing the code, and the documentation, is here:
>>>> 
>>>> <http://www.globalphasing.com/startools/>
>>>> 
>>>> Hoping that others will find this useful and/or help to resolve or clarify outstanding questions,
>>>> 
>>>> Peter.
>>>> 
>>>> -- 
>>>> Peter Keller                                     Tel.: +44 (0)1223 353033
>>>> Global Phasing Ltd.,                             Fax.: +44 (0)1223 366889
>>>> Sheraton House,
>>>> Castle Park,
>>>> Cambridge CB3 0AX
>>>> United Kingdom
>>> 
>> 

Top of Message | Previous Page | Permalink

JiscMail Tools


RSS Feeds and Sharing


Advanced Options


Archives

April 2024
March 2024
February 2024
January 2024
December 2023
November 2023
October 2023
September 2023
August 2023
July 2023
June 2023
May 2023
April 2023
March 2023
February 2023
January 2023
December 2022
November 2022
October 2022
September 2022
August 2022
July 2022
June 2022
May 2022
April 2022
March 2022
February 2022
January 2022
December 2021
November 2021
October 2021
September 2021
August 2021
July 2021
June 2021
May 2021
April 2021
March 2021
February 2021
January 2021
December 2020
November 2020
October 2020
September 2020
August 2020
July 2020
June 2020
May 2020
April 2020
March 2020
February 2020
January 2020
December 2019
November 2019
October 2019
September 2019
August 2019
July 2019
June 2019
May 2019
April 2019
March 2019
February 2019
January 2019
December 2018
November 2018
October 2018
September 2018
August 2018
July 2018
June 2018
May 2018
April 2018
March 2018
February 2018
January 2018
December 2017
November 2017
October 2017
September 2017
August 2017
July 2017
June 2017
May 2017
April 2017
March 2017
February 2017
January 2017
December 2016
November 2016
October 2016
September 2016
August 2016
July 2016
June 2016
May 2016
April 2016
March 2016
February 2016
January 2016
December 2015
November 2015
October 2015
September 2015
August 2015
July 2015
June 2015
May 2015
April 2015
March 2015
February 2015
January 2015
December 2014
November 2014
October 2014
September 2014
August 2014
July 2014
June 2014
May 2014
April 2014
March 2014
February 2014
January 2014
December 2013
November 2013
October 2013
September 2013
August 2013
July 2013
June 2013
May 2013
April 2013
March 2013
February 2013
January 2013
December 2012
November 2012
October 2012
September 2012
August 2012
July 2012
June 2012
May 2012
April 2012
March 2012
February 2012
January 2012
December 2011
November 2011
October 2011
September 2011
August 2011
July 2011
June 2011
May 2011
April 2011
March 2011
February 2011
January 2011
December 2010
November 2010
October 2010
September 2010
August 2010
July 2010
June 2010
May 2010
April 2010
March 2010
February 2010
January 2010
December 2009
November 2009
October 2009
September 2009
August 2009
July 2009
June 2009
May 2009
April 2009
March 2009
February 2009
January 2009
December 2008
November 2008
October 2008
September 2008
August 2008
July 2008
June 2008
May 2008
April 2008
March 2008
February 2008
January 2008
December 2007
November 2007
October 2007
September 2007
August 2007
July 2007
June 2007
May 2007
April 2007
March 2007
February 2007
January 2007


JiscMail is a Jisc service.

View our service policies at https://www.jiscmail.ac.uk/policyandsecurity/ and Jisc's privacy policy at https://www.jisc.ac.uk/website/privacy-notice

For help and support help@jisc.ac.uk

Secured by F-Secure Anti-Virus CataList Email List Search Powered by the LISTSERV Email List Manager