Skip to content

Commit 81d3405

Browse files
committed
Final bits of documentation
1 parent 35383e4 commit 81d3405

File tree

2 files changed

+50
-21
lines changed

2 files changed

+50
-21
lines changed

doc/SelectBigROI.md

+50-21
Original file line numberDiff line numberDiff line change
@@ -472,16 +472,6 @@ What follows has a nearly one hundred percent chance of getting removed in the f
472472

473473
One of the weaknesses of the 0.1.0 release is that it does not include support for small regions via dedicated commands so in order to extract them, currently you need to use sub indexing. This of course is not always satisfying and in certain cases can even be very annoying (for instance when editing json file). As a temporary solution so that you have something to get by until release 0.2.0 introduces small regions of interest properly , various regions have been added as Big Roi
474474

475-
A few very important things to note
476-
477-
- The way they work with nth adjectives might feel even more clumsy than usual, but this is only temporary.
478-
479-
- The search in the way the ordinal adjectives are decoded is function wide!
480-
481-
-
482-
483-
484-
485475

486476
```python
487477
"string" : "string",
@@ -526,12 +516,21 @@ A few very important things to note
526516

527517
```
528518

519+
A few very important things to note
520+
521+
- The way they work with nth adjectives might feel even more clumsy than usual, but this is only temporary.
522+
523+
- The search in the way the ordinal adjectives are decoded is function wide!
529524

530-
in the following we are going to quickly go through these regions but not in great detail because they are either way immature, highly likely subject to future change, they lack for the time being there dedicated commands and there are technicalities with some of them! But I hope you get the main idea
525+
- They can still be subindexed which can enable you to go deeper than otherwise possible in a single go!
526+
527+
- Take care with nested hierarchies!
528+
529+
In the following we are going to quickly go through these regions but not in great detail because they are either way immature, highly likely subject to future change, they lack for the time being there dedicated commands and there are technicalities with some of them! But I hope you get the main idea
531530

532531
#### Literals
533532

534-
![](./gif/big39.gif)
533+
We start with the most basic stuff namely literals!
535534

536535

537536
```python
@@ -543,10 +542,12 @@ in the following we are going to quickly go through these regions but not in gre
543542
"set" : "set",
544543
```
545544

545+
![](./gif/big39.gif)
546546

547547
#### Subscripts and Attribute
548548

549-
![](./gif/big40.gif)
549+
I hope most of them are self-explanatory, load to be honest I'm not really that satisfied with `subscript body`
550+
and perhaps using `index` instead of `key` might also be an alternative to consider
550551

551552
```python
552553
"attribute" : "attribute",
@@ -559,6 +560,11 @@ in the following we are going to quickly go through these regions but not in gre
559560
"step" : "step"
560561
```
561562

563+
there are some technicalities but I hope they do not disturb you too much!
564+
565+
![](./gif/big40.gif)
566+
567+
562568
#### Comparisons Arithmetical And Boolean Operations
563569

564570
![](./gif/big41.gif)
@@ -571,23 +577,38 @@ in the following we are going to quickly go through these regions but not in gre
571577

572578
#### More On Comparisons
573579

574-
![](./gif/big42.gif)
580+
Now to have a little bit more fun, given thought in most cases comparisons typically have two or maybe three comparators, we also provide regions corresponding to the left medial or right side of such a comparison
575581

576582
```python
577-
"member": "member",
578-
"container": "container",
579-
"membership" : "membership",
580-
581583
"left side" : "left side",
582584
"right side" : "right side",
583585
"middle" : "middle",
584586
```
585587

586-
#### More On Boolean
588+
Which combined with sub indexing, enables you to go to levels deep within such a condition! now under the term comparison there are actually three things:
587589

590+
* The more traditional `==`,`<`,`>`,and so on
588591

589-
![](./gif/big43.gif)
592+
* The identity comparison `is` and `is not`
593+
594+
* Checking if an item belongs to a sequence with the `in` and `not in` keywords
595+
596+
For the latter of the three, dedicated regions are provided in order to maximize ease of use and flexibility
597+
598+
```python
599+
"member": "member",
600+
"container": "container",
601+
"membership" : "membership",
602+
```
603+
604+
To visualize all of the above
605+
606+
![](./gif/big42.gif)
607+
608+
609+
#### More On Boolean
590610

611+
we can also get left middle right parts off a Boolean expression or we can specify whether we are interested in operations using `and` or `or`
591612

592613
```python
593614
"boolean left" : "boolean left",
@@ -598,16 +619,24 @@ in the following we are going to quickly go through these regions but not in gre
598619
"boolean or" : "boolean or",
599620
```
600621

622+
623+
![](./gif/big43.gif)
624+
625+
626+
601627
#### More On Arithmetic
602628

603-
![](./gif/big44.gif)
629+
As usual the left middle right pattern applies also to arithmetical operations
604630

605631
```python
606632
"arithmetic left" : "arithmetic left" ,
607633
"arithmetic right" : "arithmetic right",
608634
"arithmetic middle" : "arithmetic middle",
609635
```
610636

637+
![](./gif/big44.gif)
638+
639+
611640

612641

613642

doc/gif/big43.gif

396 KB
Loading

0 commit comments

Comments
 (0)